Objeto x-amazon-apigateway-gateway-responses
Define las respuestas de gateway de una API como un mapa de pares de clave-valor de cadena a GatewayResponse. La extensión se aplica a la estructura de OpenAPI en el nivel raíz.
Nombre de la propiedad | Tipo | Descripción |
---|---|---|
|
x-amazon-apigateway-gateway-responses.gatewayResponse |
Un atributo |
Ejemplo de x-amazon-apigateway-gateway-responses
El siguiente ejemplo de extensión de API Gateway para OpenAPI define un mapa de GatewayResponses que contiene dos instancias de GatewayResponse, una para el tipo DEFAULT_4XX
y otra para el tipo 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 }" } } } }