Objeto x-amazon-apigateway-gateway-responses.gatewayResponse - Amazon API Gateway
Ejemplo de x-amazon-apigateway-gateway-responses.gatewayResponse

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

Define una respuesta de gateway de un tipo de respuesta determinado, incluido el código de estado, todos los parámetros de respuesta aplicables o las plantillas de respuesta.

Nombre de la propiedad Tipo Descripción
responseParameters x-amazon-apigateway-gateway-responses.responseParameters

Especifica los parámetros de GatewayResponse, es decir, los parámetros de encabezado. Los valores de los parámetros pueden tomar cualquier valor de parámetro de solicitud entrante o un valor personalizado estático.
responseTemplates x-amazon-apigateway-gateway-responses.responseTemplates

Especifica las plantillas de mapeo de la respuesta de gateway. El motor de VTL no procesa las plantillas.
statusCode string

Un código de estado HTTP para la respuesta de gateway.

Ejemplo de x-amazon-apigateway-gateway-responses.gatewayResponse

El siguiente ejemplo de extensión de API Gateway para OpenAPI define un objeto GatewayResponse para personalizar la respuesta INVALID_API_KEY y devolver el código de estado 456, el valor del encabezado api-key de la solicitud entrante y un mensaje "Bad api-key". 


    "INVALID_API_KEY": {
      "statusCode": "456",
      "responseParameters": {
        "gatewayresponse.header.api-key": "method.request.header.api-key"
      },
      "responseTemplates": {
        "application/json": "{\"message\": \"Bad api-key\" }"
      }
    }