API de BadWord

Vision General

La API de BadWord es para gestionar las palabras prohibidas (exclusion de palabras de sugerencia inapropiadas) de Fess. Puede configurar palabras clave que no desea mostrar en la funcion de sugerencias.

URL Base

/api/admin/badword

Lista de Endpoints

Metodo Ruta Descripcion
GET /settings Obtener lista de palabras prohibidas
GET /setting/{id} Obtener palabra prohibida
POST /setting Crear palabra prohibida
PUT /setting Actualizar palabra prohibida
DELETE /setting/{id} Eliminar palabra prohibida
PUT /upload Subir CSV de palabras prohibidas
GET /download Descargar CSV de palabras prohibidas

Obtener Lista de Palabras Prohibidas

Solicitud

GET /api/admin/badword/settings

Parametros

Respuesta

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "badword_id_1",
        "suggestWord": "inappropriate_word"
      }
    ],
    "total": 5
  }
}

Obtener Palabra Prohibida

Solicitud

GET /api/admin/badword/setting/{id}

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "badword_id_1",
      "suggestWord": "inappropriate_word"
    }
  }
}

Crear Palabra Prohibida

Solicitud

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

Cuerpo de la Solicitud

{
  "suggestWord": "spam_keyword"
}

Descripcion de Campos

Respuesta

{
  "response": {
    "status": 0,
    "id": "new_badword_id",
    "created": true
  }
}

Actualizar Palabra Prohibida

Solicitud

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

Cuerpo de la Solicitud

{
  "id": "existing_badword_id",
  "suggestWord": "updated_spam_keyword",
  "versionNo": 1
}

Respuesta

{
  "response": {
    "status": 0,
    "id": "existing_badword_id",
    "created": false
  }
}

Eliminar Palabra Prohibida

Solicitud

DELETE /api/admin/badword/setting/{id}

Respuesta

{
  "response": {
    "status": 0,
    "id": "deleted_badword_id",
    "created": false
  }
}

Subir CSV de Palabras Prohibidas

Registra palabras prohibidas en bloque a partir de un archivo CSV. El archivo se envia como multipart/form-data. La importacion se ejecuta de forma asincrona en el servidor.

Solicitud

PUT /api/admin/badword/upload
Content-Type: multipart/form-data

Parametros

Parametro Requerido Descripcion
badWordFile Si Archivo CSV de palabras prohibidas a subir

Formato CSV

  • La primera linea se omite como fila de encabezado (el nombre de la columna es arbitrario; al descargar se escribe BadWord).

  • A partir de la segunda linea, escriba una palabra prohibida por linea como suggestWord.

  • Las lineas cuyo valor esta en blanco se ignoran.

  • Anteponga -- a una palabra para eliminarla (por ejemplo, --spam elimina spam).

  • Especificar una palabra ya registrada se trata como una actualizacion (se restablecen el usuario y la fecha de actualizacion).

Nota

Dado que la importacion se ejecuta de forma asincrona en el servidor, una respuesta status: 0 indica que la solicitud fue aceptada, no que la importacion se haya completado.

Respuesta

{
  "response": {
    "status": 0
  }
}

Descargar CSV de Palabras Prohibidas

Descarga las palabras prohibidas registradas como archivo CSV (badword.csv). La respuesta es un flujo application/octet-stream. El CSV tiene una fila de encabezado BadWord en la primera linea, seguida de una palabra prohibida registrada por linea.

Solicitud

GET /api/admin/badword/download

Ejemplos de Uso

Excluir Palabra Clave de Spam

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

Subir Archivo CSV

curl -X PUT "http://localhost:8080/api/admin/badword/upload" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -F "badWordFile=@badword.csv"

Descargar Archivo CSV

curl -X GET "http://localhost:8080/api/admin/badword/download" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -o badword.csv

Informacion de Referencia