API de cache

Ce document décrit l’API de cache v2 de Fess. Pour l’enveloppe de réponse commune, le modèle d’erreur et les jetons CSRF, voir Vue d’ensemble de l’API.

L’URL de base est http://<Server Name>/api/v2/ (exemple en environnement local : http://localhost:8080/api/v2).

Récupération d’un document en cache

Requête

Méthode HTTP	GET
Point de terminaison	`/api/v2/cache/{docId}`

Retourne le HTML en cache (avec mise en évidence appliquée) d’un document.

Si app.login.required=true et que l’appelant est anonyme, une erreur auth_required (401) est retournée.

Paramètres de requête

Paramètres de requête
`docId`	Identifiant du document (path, obligatoire, motif `^[A-Za-z0-9_-]+$`).
`hq`	Terme de requête pour la mise en évidence (query). Peut être répété (tableau).

Tableau : Paramètres de requête

Réponse

En cas de succès (200), les champs suivants sont retournés directement sous response dans l’enveloppe commune.

{
  "response": {
    "status": 0,
    "doc_id": "a1b2c3d4e5f6",
    "mimetype": "text/html",
    "content": "<html><body>...</body></html>",
    "url": "https://example.com/",
    "created": "2024-05-31T12:00:00.000Z",
    "charset": "UTF-8"
  }
}

Les détails de chaque champ sont les suivants.

Champs de réponse
`doc_id`	Identifiant du document (str).
`mimetype`	Type MIME (enum : `text/html`).
`content`	Corps HTML en cache (str).
`url`	URL du document (str). Utilise le champ `url_link` s’il existe, sinon l’URL brute de l’index. Omis si aucune des deux n’est disponible.
`created`	Horodatage de création du document dans l’index (str). Omis s’il n’existe pas.
`charset`	Jeu de caractères extrait du mimetype du document (str). `UTF-8` par défaut si absent.

Tableau : Champs de réponse

Réponse d’erreur

Pour le détail du modèle d’erreur, voir Vue d’ensemble de l’API. Les statuts HTTP retournés par ce point de terminaison sont les suivants.

Réponses d’erreur
Code de statut	Description
400 Bad Request	La requête est incorrecte.
401 Unauthorized	Authentification requise (`app.login.required=true` avec appelant anonyme).
404 Not Found	Ressource introuvable.
405 Method Not Allowed	La méthode HTTP n’est pas autorisée.
500 Internal Server Error	Une erreur interne s’est produite sur le serveur.

Tableau : Réponses d’erreur