API Suggest

Vue d’ensemble

L’API Suggest permet de gerer la fonctionnalite de suggestion de Fess. Vous pouvez ajouter, supprimer et mettre a jour les mots de suggestion.

URL de base

/api/admin/suggest

Liste des endpoints

Methode Chemin Description
GET/PUT /settings Obtention de la liste des mots de suggestion
GET /setting/{id} Obtention d’un mot de suggestion
POST /setting Creation d’un mot de suggestion
PUT /setting Mise a jour d’un mot de suggestion
DELETE /setting/{id} Suppression d’un mot de suggestion
DELETE /delete-all Suppression de tous les mots de suggestion

Obtention de la liste des mots de suggestion

Requete

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

Parametres

Reponse

{
  "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
  }
}

Obtention d’un mot de suggestion

Requete

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

Reponse

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

Creation d’un mot de suggestion

Requete

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

Corps de la requete

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

Description des champs

Reponse

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

Mise a jour d’un mot de suggestion

Requete

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

Corps de la requete

{
  "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
}

Reponse

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

Suppression d’un mot de suggestion

Requete

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

Reponse

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

Suppression de tous les mots de suggestion

Requete

DELETE /api/admin/suggest/delete-all

Reponse

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

Exemples d’utilisation

Ajout d’un mot-cle populaire

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
     }'

Suppression en masse des suggestions

# Supprimer toutes les suggestions
curl -X DELETE "http://localhost:8080/api/admin/suggest/delete-all" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informations complementaires