Aller au contenu principal

Configuration du Timeout

Permettre au fournisseur d'API de définir une durée de timeout custom lors de la consommation de son API par l'API gateway.

Principe de fonctionnement​

L’API Gateway applique un délai d’attente (timeout) avant de considérer qu’un appel à un endpoint a échoué. Par défaut, ce délai est fixé à 30 000 ms (30 secondes). Si le serveur de l’API ne répond pas dans ce laps de temps, une erreur de timeout est automatiquement retournée. Dans certains cas, il peut être nécessaire d’adapter cette valeur :

  • lorsque les temps de réponse de votre API dépassent 30 secondes
  • lorsque vous souhaitez réduire le temps d’attente afin de limiter l’impact sur les connexions et les ressources.

Le timeout peut être configuré :

  • globalement, au niveau d’un environnement
  • spécifiquement, pour une route donnée

Cette flexibilité permet d’adapter le comportement de l’API Gateway aux besoins et aux contraintes de chaque API.

Exemple de configuration​

Dans la configuration de l'API et dans le namespace type: environment ou type: resource, au niveau de l'attribut extra :

  value: production # sandbox, ou tout autre environnement
  ...
  extra:
    timeout: 60000 # On augmente la durée de timeout pour éviter trop d'erreurs si l'API est trop lente. 60000 corresponds à 60 secondes