Badword API

Übersicht

Die Badword API dient zur Verwaltung von verbotenen Wörtern (Bad words) in Fess. Diese Wörter werden aus Suchvorschlägen ausgeschlossen.

Basis-URL

/api/admin/badword

Endpunktliste

Methode Pfad Beschreibung
GET/PUT /settings Bad word Liste abrufen
GET /setting/{id} Bad word abrufen
POST /setting Bad word erstellen
PUT /setting Bad word aktualisieren
DELETE /setting/{id} Bad word löschen

Bad word erstellen

Request

POST /api/admin/badword/setting
Content-Type: application/json

Request-Body

{
  "suggestword": "inappropriate term"
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
suggestword Ja Das zu blockierende Wort

Verwendungsbeispiele

curl -X POST "http://localhost:8080/api/admin/badword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestword": "blocked term"
     }'

Referenzinformationen