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

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

Eigenschaften
Name der Eigenschaft	Typ	Beschreibung
responseParameters	x-amazon-apigateway-gateway-responses.responseParameters	Gibt die GatewayResponse-Parameter an, nämlich die 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

Im folgenden Beispiel für eine API Gateway-Erweiterung für OpenAPI wird eine GatewayResponse zur Anpassung der INVALID_API_KEY-Antwort definiert, um den Statuscode 456, den api-key-Header-Wert der eingehenden Anfrage und eine "Bad api-key"-Nachricht zurückzugeben.

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