Gateway-Antworten für REST APIs in API Gateway

Eine Gateway-Antwort wird durch einen Antworttyp identifiziert, der von API Gateway definiert wird. Die Antwort besteht aus einem HTTP Statuscode, einer Reihe zusätzlicher Header, die durch Parameterzuordnungen spezifiziert werden, und einer Nutzlast, die von einer Vorlage ohne Zuordnung generiert wird. VTL

Im API Gateway wird eine REST API Gateway-Antwort durch den dargestellt. GatewayResponse In Open API wird eine GatewayResponse Instanz durch die x-amazon-apigateway-gateway-response beschrieben. gatewayResponseErweiterung.

Um eine Gateway-Antwort zu aktivieren, richten Sie eine Gateway-Antwort für einen unterstützten Antworttyp auf der API Ebene ein. Immer wenn API Gateway eine Antwort dieses Typs zurückgibt, werden die in der Gateway-Antwort definierten Header-Mappings und Payload-Zuordnungsvorlagen angewendet, um die zugewiesenen Ergebnisse an den Anrufer zurückzugeben. API

Im folgenden Abschnitt zeigen wir, wie Sie Gateway-Antworten mithilfe der Gateway-Konsole und des API Gateways einrichten. API REST API

Einrichten von Gateway-Antworten, um Fehlerantworten anzupassen

Wenn API Gateway eine eingehende Anfrage nicht verarbeiten kann, gibt es eine Fehlerantwort an den Client zurück, ohne die Anfrage an das Integrations-Backend weiterzuleiten. Standardmäßig enthält diese Meldung eine kurze Beschreibung des Fehlers. Wenn Sie beispielsweise versuchen, einen Vorgang für eine undefinierte API Ressource aufzurufen, erhalten Sie eine Fehlerantwort mit der { "message": "Missing Authentication Token" } Meldung. Wenn Sie neu bei API Gateway sind, fällt es Ihnen möglicherweise schwer zu verstehen, was tatsächlich schief gelaufen ist.

Bei einigen der Fehlerantworten ermöglicht API Gateway die Anpassung durch API Entwickler, sodass die Antworten in verschiedenen Formaten zurückgegeben werden. Bei dem Beispiel Missing Authentication Token können Sie der ursprünglichen Antwortnutzlast einen Hinweis auf die Fehlerursache hinzufügen, wie in diesem Beispiel: {"message":"Missing Authentication Token", "hint":"The HTTP method or resources may not be supported."}.

Wenn Sie zwischen einer externen Börse und der AWS Cloud API vermitteln, verwenden Sie VTL Zuordnungsvorlagen für Integrationsanfragen oder Integrationsantworten, um die Nutzdaten von einem Format einem anderen Format zuzuordnen. Die VTL Zuordnungsvorlagen funktionieren jedoch nur für gültige Anfragen mit erfolgreichen Antworten.

Bei ungültigen Anfragen umgeht API Gateway die Integration vollständig und gibt eine Fehlerantwort zurück. Sie müssen die Anpassung für die Fehlermeldungen nutzen, um diese in einem austauschkonformen Format darzustellen. Hier wird die Anpassung in einer Vorlage ohne VTL Zuordnung wiedergegeben, die nur einfache Variablenersetzungen unterstützt.

Wenn wir die vom API Gateway generierte Fehlerantwort auf alle von Gateway generierten Antworten verallgemeinern, bezeichnen wir sie als API Gateway-Antworten. Dies unterscheidet vom API Gateway generierte Antworten von den Integrationsantworten. Eine Mapping-Vorlage für eine Gateway-Antwort kann auf $context-Variablenwerte und $stageVariables-Eigenschaftswerte sowie auf Methodenanforderungs-Parameter im Format method.request.param-position.param-name zugreifen.

Weitere Informationen zu $context-Variablen finden Sie unter $contextVariablen für Datenmodelle, Autorisierer, Zuordnungsvorlagen und CloudWatch Zugriffsprotokollierung. Mehr über $stageVariables erfahren Sie unter $stageVariables. Weitere Informationen zu Methodenanforderungs-Parametern finden Sie unter $input-Variablen.