x-amazon-apigateway-gateway-Antworten. responseTemplates Objekt

Definiert GatewayResponseZuordnungsvorlagen als string-to-string Zuordnung von Schlüssel-Wert-Paaren für eine bestimmte Gateway-Antwort. Für jedes Schlüssel-Wert-Paar ist der Schlüssel der Inhaltstyp. Zum Beispiel ist "application/json" und der Wert eine "stringify"-Mapping-Vorlage für einfache Variablenersetzungen. Eine GatewayResponse Mapping-Vorlage wird von der Velocity Template Language (VTL) -Engine nicht verarbeitet.

Name der Eigenschaft	Typ	Beschreibung
content-type	string	Eine GatewayResponse-Text-Mapping-Vorlage, die nur einfache Variablenersetzungen unterstützt, um einen Gateway-Antworttext anzupassen.

x-amazon-apigateway-gateway-Antworten. responseTemplates Beispiel

Das folgende Beispiel für Open API Extensions zeigt eine GatewayResponseZuordnungsvorlage zum Anpassen einer vom API Gateway generierten Fehlerantwort in ein anwendungsspezifisches Format.

      "responseTemplates": {
        "application/json": "{ \"message\": $context.error.messageString, \"type\":$context.error.responseType, \"statusCode\": '488' }"
      }

Das folgende Beispiel für Open API extensions zeigt eine GatewayResponseZuordnungsvorlage, mit der eine vom API Gateway generierte Fehlerantwort mit einer statischen Fehlermeldung überschrieben werden kann.

      "responseTemplates": {
        "application/json": "{ \"message\": 'API-specific errors' }"
      }