x-amazon-apigateway-integrationobjet .response - Amazon API Gateway

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

x-amazon-apigateway-integrationobjet .response

Définit une réponse et spécifie les mappages de paramètres ou les mappages de charge utile de la réponse d'intégration à la réponse de méthode.

Propriétés
Nom de la propriété Type Description
statusCode string

Code d'état HTTP de la réponse de méthode, par exemple, "200". Cette valeur doit correspondre à une réponse correspondante dans le champ responses de l'objet opération OpenAPI.

responseTemplates x-amazon-apigateway-integrationObjet .ResponseTemplates

Spécifie les modèles de mappage spécifiques au type MIME pour la charge utile de la réponse.

responseParameters x-amazon-apigateway-integrationObjet .ResponseParameters

Spécifie les mappages de paramètres pour la réponse. Seuls les paramètres header et body de la réponse d'intégration peuvent être mappés aux paramètres header de la méthode.

contentHandling string Types de conversion de l'encodage des charges utiles de réponse. Les valeurs valides sont 1) CONVERT_TO_TEXT, pour la conversion d'une charge utile binaire en chaîne encodée en base64 ou pour la conversion d'une charge utile de texte en chaîne encodée en utf-8 ou pour le passage de la charge utile de texte en mode natif sans modification, et 2) CONVERT_TO_BINARY, pour la conversion d'une charge utile de texte en bloc encodé en base64 ou le passage par une charge utile binaire en mode natif sans modification.

x-amazon-apigateway-integration.responseExemple

L'exemple suivant définit une réponse 302 pour la méthode qui dérive une charge utile du type MIME application/json ou application/xml du backend. La réponse utilise les modèles de mappage fournis et renvoie l'URL de redirection à partir de la réponse d'intégration dans l'en-tête Location de la méthode.

{ "statusCode" : "302", "responseTemplates" : { "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }", "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> " }, "responseParameters" : { "method.response.header.Location": "integration.response.body.redirect.url" } }