x-amazon-apigateway-integrationobjet .response - APIPasserelle Amazon
x-amazon-apigateway-integration.responseExemple

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.

Nom de la propriété Type Description
statusCode string

HTTPcode d'état pour la réponse de la méthode ; par exemple,"200". Cela doit correspondre à une réponse correspondante dans le responses champ Open API Operation.
responseTemplates x-amazon-apigateway-integration. responseTemplates objet

Spécifie des modèles de mappage MIME spécifiques au type pour la charge utile de la réponse.
responseParameters x-amazon-apigateway-integration. responseParameters objet

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 302 réponse pour la méthode qui dérive une charge utile de application/xml MIME type application/json ou à partir du backend. La réponse utilise les modèles de mappage fournis et renvoie la redirection URL depuis la réponse d'intégration dans l'Locationen-tête 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"
    }
}