Objeto x-amazon-apigateway-gateway-responses.responseTemplates
Define las plantillas de asignación de GatewayResponse, como un mapa de cadena a cadena de pares de clave-valor, para una respuesta de gateway especificada. En cada par clave-valor, la clave es el tipo de contenido. Por ejemplo, "application/json" y el valor es una plantilla de mapeo stringified para sustituciones de variables simples. El motor de Velocity Template Language (VTL)GatewayResponse
.
Nombre de la propiedad | Tipo | Descripción |
---|---|---|
|
string |
Una plantilla de mapeo de cuerpo de |
Ejemplo de x-amazon-apigateway-gateway-responses.responseTemplates
El siguiente ejemplo de extensión de OpenAPI muestra una plantilla de asignación de GatewayResponse para personalizar una respuesta de error generada por API Gateway en un formato específico de la aplicación.
"responseTemplates": { "application/json": "{ \"message\": $context.error.messageString, \"type\":$context.error.responseType, \"statusCode\": '488' }" }
El siguiente ejemplo de extensión de OpenAPI muestra una plantilla de asignación de GatewayResponse para invalidar una respuesta de error generada por API Gateway con un mensaje de error estático.
"responseTemplates": { "application/json": "{ \"message\": 'API-specific errors' }" }