x-amazon-apigateway-gateway-Objeto ResponseTemplates ResponseTemplates - 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-gateway-Objeto ResponseTemplates ResponseTemplates

Define modelos de GatewayResponsemapeamento, como um string-to-string mapa de pares de valores-chave, para uma determinada resposta do gateway. Para cada par chave-valor, a chave é o tipo de conteúdo. Por exemplo, “application/json” e o valor são um modelo de mapeamento stringified para substituições de variáveis simples. Um modelo de mapeamento GatewayResponse não é processado pelo mecanismo Velocity Template Language (VTL).

Propriedades
Nome da propriedade Tipo Descrição
content-type string

Um modelo de mapeamento de corpo GatewayResponse que oferece suporte apenas à substituição de variáveis simples para personalizar um corpo de resposta de gateway.

x-amazon-apigateway-gateway- Exemplo de responseTemplates. ResponseTemplates

O exemplo de extensões OpenAPI a seguir mostra um modelo de GatewayResponsemapeamento para personalizar uma resposta de erro gerada pelo API Gateway em um formato específico do aplicativo.

"responseTemplates": { "application/json": "{ \"message\": $context.error.messageString, \"type\":$context.error.responseType, \"statusCode\": '488' }" }

O exemplo de extensões OpenAPI a seguir mostra um modelo de GatewayResponsemapeamento para substituir uma resposta de erro gerada pelo API Gateway por uma mensagem de erro estática.

"responseTemplates": { "application/json": "{ \"message\": 'API-specific errors' }" }