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

Define modelos de mapeamento GatewayResponse, como um mapa de string para string de pares de chave/valor para uma determinada resposta de 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).

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

O exemplo de extensões do OpenAPI a seguir mostra um modelo de mapeamento GatewayResponse 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 do OpenAPI a seguir mostra um modelo de mapeamento GatewayResponse para substituir uma resposta de erro gerada pelo API Gateway por uma mensagem de erro estática.

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