View a markdown version of this page

Objet x-amazon-apigateway-gateway-responses - 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.

Objet x-amazon-apigateway-gateway-responses

Définit les réponses de passerelle pour une API sous la forme d'une carte GatewayResponse chaîne-à-carte de paires clé-valeur. L'extension s'applique à la structure OpenAPI au niveau racine.

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

A GatewayResponse pour la valeur spécifiéeresponseType.

Exemple x-amazon-apigateway-gateway-responses

L'exemple d'extension API Gateway vers OpenAPI suivant définit une GatewayResponses carte contenant deux GatewayResponse instances, l'une pour le DEFAULT_4XX type et l'autre pour le type. INVALID_API_KEY

{ "x-amazon-apigateway-gateway-responses": { "DEFAULT_4XX": { "responseParameters": { "gatewayresponse.header.Access-Control-Allow-Origin": "'domain.com'" }, "responseTemplates": { "application/json": "{\"message\": test 4xx b }" } }, "INVALID_API_KEY": { "statusCode": "429", "responseTemplates": { "application/json": "{\"message\": test forbidden }" } } } }