From 44c654636d19fbdaed8233ee88ab6b9a5bd565df Mon Sep 17 00:00:00 2001 From: Rainnny7 Date: Thu, 20 Jun 2024 23:21:05 -0400 Subject: [PATCH] Endpoint documentation --- API/README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/API/README.md b/API/README.md index 2d6fe1f..558df91 100644 --- a/API/README.md +++ b/API/README.md @@ -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). \ No newline at end of file +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 | \ No newline at end of file