View a markdown version of this page

x-amazon-apigateway-gateway-responses-Objekt - Amazon API Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

x-amazon-apigateway-gateway-responses-Objekt

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

Name der Eigenschaft Typ Beschreibung
responseType x-amazon-apigateway-gateway-responses.gatewayResponse

A GatewayResponse für das angegebene. responseType

x-amazon-apigateway-gateway-responses-Beispiel

Das folgende Beispiel für eine API-Gateway-Erweiterung für OpenAPI definiert eine GatewayResponses Map, die zwei GatewayResponse Instanzen enthält — eine für den DEFAULT_4XX Typ und eine weitere für den Typ. INVALID_API_KEY

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