API de Suggest

Vision General

La API de Suggest es para gestionar la funcionalidad de sugerencias de Fess. Puede operar agregar, eliminar y actualizar palabras de sugerencia.

URL Base

/api/admin/suggest

Lista de Endpoints

Metodo	Ruta	Descripcion
GET/PUT	/settings	Obtener lista de palabras de sugerencia
GET	/setting/{id}	Obtener palabra de sugerencia
POST	/setting	Crear palabra de sugerencia
PUT	/setting	Actualizar palabra de sugerencia
DELETE	/setting/{id}	Eliminar palabra de sugerencia
DELETE	/delete-all	Eliminar todas las palabras de sugerencia

Obtener Lista de Palabras de Sugerencia

Solicitud

GET /api/admin/suggest/settings
PUT /api/admin/suggest/settings

Parametros

Respuesta

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "suggest_id_1",
        "text": "fess",
        "reading": "fess",
        "fields": ["title", "content"],
        "tags": ["product"],
        "roles": ["guest"],
        "lang": "ja",
        "score": 1.0
      }
    ],
    "total": 100
  }
}

Obtener Palabra de Sugerencia

Solicitud

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

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "suggest_id_1",
      "text": "fess",
      "reading": "fess",
      "fields": ["title", "content"],
      "tags": ["product"],
      "roles": ["guest"],
      "lang": "ja",
      "score": 1.0
    }
  }
}

Crear Palabra de Sugerencia

Solicitud

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

Cuerpo de la Solicitud

{
  "text": "search engine",
  "reading": "search engine",
  "fields": ["title"],
  "tags": ["feature"],
  "roles": ["guest"],
  "lang": "en",
  "score": 1.0
}

Descripcion de Campos

Respuesta

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

Actualizar Palabra de Sugerencia

Solicitud

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

Cuerpo de la Solicitud

{
  "id": "existing_suggest_id",
  "text": "search engine",
  "reading": "search engine",
  "fields": ["title", "content"],
  "tags": ["feature", "popular"],
  "roles": ["guest"],
  "lang": "en",
  "score": 2.0,
  "versionNo": 1
}

Respuesta

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

Eliminar Palabra de Sugerencia

Solicitud

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

Respuesta

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

Eliminar Todas las Palabras de Sugerencia

Solicitud

DELETE /api/admin/suggest/delete-all

Respuesta

{
  "response": {
    "status": 0,
    "count": 250
  }
}

Ejemplos de Uso

Agregar Palabra Clave Popular

curl -X POST "http://localhost:8080/api/admin/suggest/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "text": "getting started",
       "fields": ["title"],
       "tags": ["tutorial"],
       "roles": ["guest"],
       "lang": "en",
       "score": 5.0
     }'

Eliminacion Masiva de Sugerencias

# Eliminar todas las sugerencias
curl -X DELETE "http://localhost:8080/api/admin/suggest/delete-all" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informacion de Referencia

• Vision General de Admin API - Vision general de Admin API

• API de BadWord - API de palabras prohibidas

• API de ElevateWord - API de palabras elevadas

• Palabra sugerida - Guia de gestion de sugerencias