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

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

Define uma resposta de gateway de um tipo de resposta especificado, incluindo o código de status, todos os parâmetros de resposta aplicáveis ou modelos de resposta.

Propriedades
Nome da propriedade Tipo Descrição
responseParameters x-amazon-apigateway-gateway-responses.responseParameters

Especifica os parâmetros GatewayResponse, ou seja, os parâmetros de cabeçalho. Os valores de parâmetros podem usar qualquer valor de parâmetro de solicitação de entrada ou um valor personalizado estático.

responseTemplates x-amazon-apigateway-gateway-responses.responseTemplates

Especifica os modelos de mapeamento da resposta de gateway. Os modelos não são processados pelo mecanismo VTL.

statusCode string

Um código de status HTTP da resposta do gateway.

Exemplo de x-amazon-apigateway-gateway-responses.gatewayResponse

O exemplo a seguir da extensão do API Gateway para OpenAPI define uma GatewayResponse para personalizar a resposta INVALID_API_KEY de forma a retornar o código de status de 456, o valor do cabeçalho api-key da solicitação de entrada e a mensagem "Bad api-key".

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