View a markdown version of this page

x-amazon-apigateway-gateway-responses.gatewayResponse-Objekt - Amazon API Gateway
x-amazon-apigateway-gateway-responses.gatewayResponse-Beispiel

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.gatewayResponse-Objekt

Definiert eine Gateway-Antwort eines bestimmten Antworttyps, einschließlich des Statuscodes, sämtlicher geltender Antwortparameter oder Antwortvorlagen.

Eigenschaftenname Typ Beschreibung
responseParameters x-amazon-apigateway-gateway-responses.responseParameters

Gibt die Parameter an, nämlich die GatewayResponse Header-Parameter. Die Parameterwerte können jeden beliebigen eingehenden request parameter-Wert oder einen statischen benutzerdefinierten Wert übernehmen.
responseTemplates x-amazon-apigateway-gateway-responses.responseTemplates

Gibt die Mapping-Vorlagen der Gateway-Antwort an. Die Vorlagen werden nicht von der VTL-Engine verarbeitet.
statusCode string

Ein HTTP-Statuscode für die Gateway-Antwort.

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

Das folgende Beispiel für die API Gateway-Erweiterung für OpenAPI definiert eine, GatewayResponse um die INVALID_API_KEY Antwort so anzupassen, dass der Statuscode von456, der api-key Header-Wert der eingehenden Anfrage und eine "Bad api-key" Nachricht zurückgegeben werden. 


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