Return response

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

La stratégie return-response annule l’exécution du pipeline et renvoie une réponse par défaut ou personnalisée à l’appelant. La réponse par défaut est 200 OK sans corps. La réponse personnalisée peut être spécifiée par le biais d’instructions de stratégie ou d’une variable de contexte. Lorsque les deux sont fournies, la réponse contenue dans la variable de contexte est modifiée par les instructions de stratégie avant d’être renvoyée à l’appelant.

Notes

Définissez les éléments enfants et de stratégie dans l’ordre fourni dans l’instruction de stratégie. En savoir plus sur comment définir ou modifier des stratégies du service Gestion des API.

Instruction de la stratégie

<return-response response-variable-name="existing context variable">
  <set-status>...</set-status>
  <set-header>...</set-header>
  <set-body>...</set-body>
</return-response>

Attributs

Attribut	Description	Obligatoire	Default
response-variable-name	Nom de la variable de contexte référencée à partir par exemple d’une stratégie send-request en amont et contenant un objet Response. Les expressions de stratégie ne sont pas autorisées.	Non	N/A

Éléments

Élément	Description	Obligatoire
set-status	Définit le code d’état de la réponse.	Non
set-header	Définit un en-tête dans la réponse.	Non
set-body	Définit le corps dans la réponse.	Non

Usage

• Sections de la stratégie : inbound, outbound, backend, on-error
• Étendues de la stratégie : global, espace de travail, produit, API, opération
• Passerelles : classiques, v2, consommation, auto-hébergées, espace de travail

Notes d’utilisation

• Un modèle liquide ne fonctionne pas lorsqu’il est spécifié dans le corps (défini à l’aide de set-body) de la stratégie return-response. La stratégie return-response annule l’actuel pipeline d’exécution et supprime le corps de la requête, ainsi que le corps de la réponse dans le contexte actuel. Par conséquent, un modèle liquide spécifié dans la stratégie reçoit une chaîne vide comme entrée et ne produit pas la sortie attendue.

Exemple

<return-response>
   <set-status code="401" reason="Unauthorized"/>
   <set-header name="WWW-Authenticate" exists-action="override">
      <value>Bearer error="invalid_token"</value>
   </set-header>
</return-response>

Stratégies connexes

• Transformation

Contenu connexe

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

• Tutoriel : Transformer et protéger votre API
• Référence de stratégie pour obtenir la liste complète des instructions et des paramètres de stratégie
• Expressions de stratégie
• Définir ou modifier des stratégies
• Réutilisation de configurations de stratégie
• Référentiel d’extrait de stratégie
• Créer des stratégies à l’aide de Microsoft Copilot dans Azure