As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
x-amazon-apigateway-gateway-Response.objeto 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
x-amazon-apigateway-gateway- Respostas. Parâmetros de resposta |
Especifica os GatewayResponseparâmetros, ou seja, os parâmetros do 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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
x-amazon-apigateway-gateway- Respostas. Modelos de resposta |
Especifica os modelos de mapeamento da resposta de gateway. Os modelos não são processados pelo mecanismo VTL. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
string |
Um código de status HTTP da resposta do gateway. |
x-amazon-apigateway-gateway-respondes.Exemplo de GatewayResponse
O exemplo a seguir da extensão do API Gateway para OpenAPI define GatewayResponsea para personalizar a INVALID_API_KEY
resposta para retornar o código de status de456
, o valor do api-key
cabeçalho da solicitação recebida e uma 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\" }" } }