x-amazon-apigateway-integrationobjeto.response - Amazon API Gateway

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-integrationobjeto.response

Define uma resposta e especifica mapeamentos de parâmetros ou mapeamentos de carga a partir da resposta de integração para a resposta de método.

Propriedades
Nome da propriedade Tipo Descrição
statusCode string

Código de status HTTP para a resposta de método; por exemplo, "200". Isso deve equivaler a uma resposta correspondente no campo responses da Operação do OpenAPI.

responseTemplates x-amazon-apigateway-integration.objeto responseTemplates

Especifica modelos de mapeamento específicos de tipo MIME para a carga da resposta.

responseParameters x-amazon-apigateway-integration.objeto responseParameters

Especifica mapeamentos de parâmetros para a resposta. Somente os parâmetros header e body da resposta de integração podem ser mapeados para os parâmetros header do método.

contentHandling string Tipos de conversão de codificação da carga de resposta. Os valores válidos são 1) CONVERT_TO_TEXT, para converter uma carga binária em uma string codificada em base64 ou converter uma carga de texto em uma string codificada por utf-8 ou transferir a carga de texto de forma nativa sem modificação e 2) CONVERT_TO_BINARY para converter uma carga de texto em um blob decodificado em base64 ou transferir uma carga binária de forma nativa sem modificação.

Exemplo de x-amazon-apigateway-integration.response

O exemplo a seguir define uma resposta 302 para o método que deriva uma carga do tipo MIME do application/json ou do application/xml no backend. A resposta usa os modelos de mapeamento fornecidos e retorna a URL de redirecionamento da resposta de integração no cabeçalho Location do método.

{ "statusCode" : "302", "responseTemplates" : { "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }", "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> " }, "responseParameters" : { "method.response.header.Location": "integration.response.body.redirect.url" } }