Gestion du cache

Permet à l'API d'activer une gestion de cache au niveau de l'API gateway afin de préserver le endpoint de l'API, pour des raisons de performances et/ou disponibilité.

info

Le cache ne fontionne que pour les ressources de type GET.

Principe de fonctionnement

L'API déclare dans son raccordement les données relatives au cache sous le namespace cache dans les données optionnelles (extra). Les attributs de ce namespace sont les suivants :

• ttl (integer) : Durée de vie du cache (en secondes)

Lorsque la gestion du cache est activée, l'API Gateway persiste le contenu de chaque requête des clients pendant une durée précisée par cet attribut ttl

warning

Le cache ne se base que sur l'URL appelée. Il ne doit donc être activé que sur des apis/ressources où les données sont partagées. Par exemple un GET /users/me qui retournerait des données en fonction de l'utilisateur authentifié, retrournerait les données d'un autre utilisateur.

Configuration dans le raccordement de l'API

- type: api
  value:
    name: My Api
    urlContext: monapi
    version: '1'
    ...
    plugins: ["api-cache"]
    extra:
      cache:
        ttl: 3600

Configuration au niveau d'une ressource spécifique

- type: resource
  value:
    name: My Resource
    methode: get
    route: /myresource
    ...
    plugins: ["api-cache"]
    extra:
      cache:
        ttl: 3600