View a markdown version of this page

Objet x-amazon-apigateway-gateway-responses.gatewayResponse - Amazon API Gateway
Exemple x-amazon-apigateway-gateway-responses.gatewayResponse

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.

Objet x-amazon-apigateway-gateway-responses.gatewayResponse

Définit une réponse de passerelle d’un type de réponse donné, y compris le code de statut, les paramètres de réponse applicables, ou les modèles de réponse.

Nom de la propriété Type Description
responseParameters x-amazon-apigateway-gateway-responses.responseParameters

Spécifie les GatewayResponse paramètres, à savoir les paramètres d'en-tête. Les valeurs des paramètres peuvent prendre n’importe quelle valeur de paramètre de demande entrante ou une valeur personnalisée statique.
responseTemplates x-amazon-apigateway-gateway-responses.responseTemplates

Spécifie les modèles de mappage de la réponse de passerelle. Les modèles ne sont pas traités par le moteur VTL.
statusCode string

Code de statut HTTP pour la réponse de passerelle.

Exemple x-amazon-apigateway-gateway-responses.gatewayResponse

L'exemple suivant de l'extension API Gateway pour OpenAPI définit un GatewayResponse pour personnaliser la INVALID_API_KEY réponse afin de renvoyer le code d'état de456, la valeur d'api-keyen-tête de la demande entrante et un "Bad api-key" message. 


    "INVALID_API_KEY": {
      "statusCode": "456",
      "responseParameters": {
        "gatewayresponse.header.api-key": "method.request.header.api-key"
      },
      "responseTemplates": {
        "application/json": "{\"message\": \"Bad api-key\" }"
      }
    }