Configurar la personalización de respuestas de gateway en OpenAPI
Puede utilizar la extensión x-amazon-apigateway-gateway-responses
en el nivel de raíz de la API para personalizar respuestas de gateway en OpenAPI. La siguiente definición de OpenAPI muestra un ejemplo de personalización de GatewayResponse del tipo MISSING_AUTHENTICATION_TOKEN
.
"x-amazon-apigateway-gateway-responses": { "MISSING_AUTHENTICATION_TOKEN": { "statusCode": 404, "responseParameters": { "gatewayresponse.header.x-request-path": "method.input.params.petId", "gatewayresponse.header.x-request-query": "method.input.params.q", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-header": "method.input.params.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" } }
En este ejemplo, la personalización cambia el código de estado del valor predeterminado (403
) a 404
. También añade a la respuesta de gateway cuatro parámetros de encabezado y una plantilla de asignación de cuerpo para el tipo de medio application/json
.