x-amazon-apigateway-gateway-responses-Objekt

Definiert die Gateway-Antworten für eine API als Zeichenfolge-zu-Zuweisung von Schlüssel-Wert-GatewayResponsePaaren. Die Erweiterung gilt für die OpenAPI-Struktur auf Stammebene.

Eigenschaften
Name der Eigenschaft	Typ	Beschreibung
responseType	x-amazon-apigateway-gateway-responses.gatewayResponse	Eine GatewayResponse für den angegebenen responseType.

x-amazon-apigateway-gatewayBeispiel für -Antworten

Die folgende API Gateway-Erweiterung für das OpenAPI-Beispiel definiert eine GatewayResponses Zuordnung, die zwei GatewayResponse Instances enthält – eine für den -DEFAULT_4XXTyp und eine für den -INVALID_API_KEYTyp.

{
  "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 }"
      }
    }
  }
}