Implémentation de la spécification Idempotency-Key sur Apache APISIX

DEV - 11/04
La semaine dernière, j'ai écrit une analyse de la spécification IETF Idempotency-Key. Le cahier des charges vise à...

La semaine dernière, j'ai écrit une analyse de la spécification IETF Idempotency-Key. La spécification vise à éviter les demandes en double. En bref, l'idée est que le client envoie une clé unique avec la requête :

  • Si le serveur ne connaît pas la clé, il procède comme d'habitude puis stocke la réponse
  • Si le serveur connaît la clé, il court-circuite tout traitement ultérieur et renvoie immédiatement la réponse stockée.

Cet article montre comment l'implémenter avec Apache APISIX.

Aperçu

Avant de commencer le codage, nous devons définir quelques éléments. Apache APISIX propose une architecture basée sur des plugins. Par conséquent, nous coderons la logique ci-dessus dans un plugin.

Apache APISIX s'appuie sur OpenResty, qui s'appuie sur nginx. Chaque composant définit des phases, qui se répartissent plus ou moins entre les composants. Pour plus d'informations sur les phases, veuillez consulter cet article précédent.

Finalement, nous déciderons d'une priorité. La priorité définit l'ordre dans lequel APISIX exécute les plugins au sein d'une phase. j'ai décidé1500, car tous les plugins d'authentification ont une priorité dans le2000et plus de plage, mais je souhaite renvoyer la réponse mise en cache dès que possible.

La spécification nous oblige à stocker des données. APISIX propose de nombreuses abstractions, mais le stockage n'en fait pas partie. Nous avons besoin d'un accès via la clé d'idempotence pour qu'elle ressemble à un magasin clé-valeur.

J'ai arbitrairement choisi Redis, car il est assez répandu et le client fait déjà partie de la distribution APISIX. Notez que Redis simple n'offre pas de stockage JSON ; par conséquent, j'utilise lepile redisImage Docker.

L'infrastructure locale est la suivante :

services : apisix : image : apache/apisix:3.9.0-debian volumes : - ./apisix/config.yml:/usr/local/apisix/conf/config.yaml:ro - ./apisix/apisix.yml:/ usr/local/apisix/conf/apisix.yaml:ro #1 - ./plugin/src:/opt/apisix/plugins:ro #2 ports : - "9080:9080" redis : image : redis/redis-stack : Ports 7.2.0-v9 : - "8001:8001" #3
Entrer en mode plein écran Quitter le mode plein écran
  1. Configuration d'itinéraire statique
  2. Chemin vers notre futur plugin
  3. Port de Redis Insights (interface graphique). Pas nécessaire en soi, mais très utile lors du développement pour le débogage

La configuration APISIX est la suivante :

déploiement : rôle : data_plane role_data_plane : config_provider : yaml #1 apisix : extra_lua_path : /opt/?.lua #2 plugins : - idempotence # priorité : 1500 #3 plugin_attr : #4 idempotence : hôte : redis #5
Entrer en mode plein écran Quitter le mode plein écran
  1. Configurer APISIX pour la configuration ...
    [Courte citation de 8% de l'article original]