View a markdown version of this page

x-amazon-apigateway-gateway-responses.responseTemplates-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.responseTemplates-Objekt

Definiert GatewayResponse Zuordnungsvorlagen als eine String-zu-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 "application/json" und der Wert ist eine stringifizierte Zuordnungsvorlage für einfache Variablenersetzungen. Eine GatewayResponse-Mapping-Vorlage wird nicht vom Velocity Template Language (VTL)-Modul verarbeitet.

Eigenschaftenname 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-responses.responseTemplates-Beispiel

Das folgende Beispiel für OpenAPI-Erweiterungen zeigt eine GatewayResponse Zuordnungsvorlage 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 OpenAPI-Erweiterungen zeigt eine GatewayResponse Zuordnungsvorlage zum Überschreiben einer vom API-Gateway generierten Fehlerantwort mit einer statischen Fehlermeldung.

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