Définition du paramètre de chaîne de requête

  • Article

S’APPLIQUE À : Tous les niveaux de Gestion des API

La stratégie set-query-parameter ajoute, supprime un paramètre de chaîne de requête de la demande ou le remplace par une autre valeur. Peut être utilisée pour transmettre les paramètres de requête attendus par le service principal qui sont facultatifs ou ne sont jamais présents dans la demande.

Notes

Définissez les éléments enfants et de stratégie dans l’ordre fourni dans l’instruction de stratégie. Pour vous aider à configurer cette stratégie, le portail fournit un éditeur guidé basé sur des formulaires. En savoir plus sur comment définir ou modifier des stratégies du service Gestion des API.

Instruction de la stratégie

<set-query-parameter name="param name" exists-action="override | skip | append | delete">
    <value>value</value> <!--for multiple parameters with the same name add additional value elements-->
</set-query-parameter>

Attributs

Nom Description Obligatoire Default
exists-action Spécifie l’action à entreprendre lorsque le paramètre de requête est déjà spécifié. Cet attribut doit avoir une des valeurs suivantes.

- override : remplace la valeur du paramètre actuel.
- skip : ne remplace pas la valeur du paramètre de requête actuel.
- append : ajoute la valeur à celle du paramètre de requête actuel.
- delete : supprime le paramètre de requête de la demande.

S’il a la valeur override, l’ajout de plusieurs entrées portant le même nom fait que le paramètre de requête est défini selon toutes les entrées (qui figurent plusieurs fois) ; seules les valeurs listées seront définies dans le résultat.

Les expressions de stratégie sont autorisées.		 Non override
name Spécifie le nom du paramètre de requête à définir. Les expressions de stratégie sont autorisées. Oui N/A

Éléments

Nom Description Obligatoire
value Fournissez une valeur au paramètre de requête à définir. Si plusieurs paramètres de requête portent le même nom, ajoutez d’autres éléments value. Les expressions de stratégie sont autorisées. Oui

Usage

Exemples

Définir la valeur du paramètre de requête


<set-query-parameter name="api-key" exists-action="skip">
  <value>12345678901</value>
</set-query-parameter>

Définir le paramètre de requête pour transférer le contexte au serveur principal

Cet exemple montre comment appliquer la stratégie au niveau de l’API pour fournir des informations de contexte au service principal.

<!-- Copy this snippet into the inbound element to forward a piece of context, product name in this example, to the backend service for logging or evaluation -->
<set-query-parameter name="x-product-name" exists-action="override">
  <value>@(context.Product.Name)</value>
</set-query-parameter>

Pour plus d’informations, consultez les pages Expressions de stratégie et Variable de contexte.

Contenu connexe

Pour plus d’informations sur l’utilisation des stratégies, consultez :