Objeto x-amazon-apigateway-gateway-responses - Amazon API Gateway

Objeto x-amazon-apigateway-gateway-responses

Define as respostas de gateway para uma API como um mapa de string para GatewayResponse de pares de chave/valor. A extensão é aplicável à estrutura OpenAPI em nível de raiz.

Nome da propriedade Tipo Descrição
responseType x-amazon-apigateway-gateway-responses.gatewayResponse

Um GatewayResponse para o responseType especificado.

Exemplo de x-amazon-apigateway-gateway-responses

A extensão demonstrativa do API Gateway para OpenAPI a seguir define um mapa GatewayResponses que contém duas instâncias de GatewayResponse, uma para o tipo DEFAULT_4XX e outra para o 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 }" } } } }