x-amazon-apigateway-gateway-responses-Objekt

Definiert die Gateway-Antworten für eine API als Zeichenfolge-zu-GatewayResponse-Zuordnung mit Schlüssel-Wert-Paaren. Die Erweiterung gilt für die OpenAPI-Struktur auf Stammebene.

x-amazon-apigateway-gateway-responses-Beispiel

Die folgende API Gateway-Erweiterung des OpenAPI-Beispiels definiert eine GatewayResponses-Zuordnung, die zwei GatewayResponse-Instances enthält – eine für den DEFAULT_4XX-Typ und eine weitere für den INVALID_API_KEY-Typ.

{
  "x-amazon-apigateway-gateway-responses": {
    "DEFAULT_4XX": {
      "responseParameters": {
        "gatewayresponse.header.Access-Control-Allow-Origin": "'domain.com'"
      },
      "responseTemplates": {
        "application/json": "{\"message\": test 4xx b }"
      }
    },
    "INVALID_API_KEY": {
      "statusCode": "429",
      "responseTemplates": {
        "application/json": "{\"message\": test forbidden }"
      }
    }
  }
}