Rainnny/TextPurify
1
0
Fork 0
Code Issues Pull Requests 1 Actions Activity

Endpoint documentation

Browse Source
This commit is contained in:
Braydon 2024-06-20 23:21:05 -04:00
parent 4e29520cc4
commit 44c654636d
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
API/README.md
View File

@ -1,2 +1,12 @@
# API
The backend API for TextPurify, responsible for the filtering and moderation of text content. The API is built using Springboot, a modern Java web framework. The API can be accessed [here](https://purify.rainnny.club).
The backend API for TextPurify, responsible for the filtering and moderation of text content. The API is built using Springboot, a modern Java web framework. The API can be accessed [here](https://purify.rainnny.club).
## Endpoints
### POST `/content/process`
This endpoint is used to filter text content. The request body should be an encoded form with the following fields:
| Field | Description | Required |
|---------------|--------------------------------------------------------|----------|
| `content` | The text content to be filtered. | Yes |
| `replaceChar` | The character to use for filtered content replacement. | No |