Enrichissement de la Query String

Permettre au fournisseur d'API de déclarer des attributs et leurs valeurs à ajouter à la query string de la requête soumise au endpoint de l'API.

Cas d'usages

• Dans l'API control adresse, certains paramètres sont requis mais ne présentent aucun intérêt pour le client. Grâce à cette fonctionnalité, Okapi peut prendre en charge ces paramètres qui sont en réalité des constantes.
• Dans l'API Suivi historique, cette fonctionnalité était utilisée pour :
  • Fournir une clé d'API propre au SI Suivi
  • Forcer la réponse au format JSON

Principe de fonctionnement

• L'API gateway ajoute à la query string fournie par la requête du client, les valeurs déclarées dans le raccordement.
• Si les attributs déclarés sont déjà fournis par la requête originale, les valeurs sont surchargées avec celles déclarées dans le raccordement.

Exemple de configuration

Dans la condiguration de l'API, au niveau de l'attribut extra.qs :

  urlContext: myapi
  version: '1'
  ...
  extra:
    qs:                         # Activation et configuration de l'enrichissement de query string 
      foo: bar                  # Ajout du paramètre 'foo' avec la valeur 'bar'
      hello: world              # Ajout du paramètre 'hello' avec la valeur 'world'