Datentransformationen für WebSocket APIs einrichten

In API Gateway kann die Methodenanforderung einer WebSocket API eine Nutzlast in einem anderen Format als die entsprechende Nutzlast der Integrationsanfrage annehmen, wie es im Backend erforderlich ist. Das Backend wiederum kann eine Integrationsantwortnutzlast zurückgeben, die nicht der Methodenantwortnutzlast entspricht, die das Frontend erwartet.

In Amazon API Gateway können Sie Zuweisungsvorlagen verwenden, um die Nutzlast einer Methodenanforderung der entsprechenden Integrationsanforderung zuzuordnen bzw. die Nutzlast einer Integrationsanforderung der entsprechenden Methodenantwort zuzuordnen. Sie geben einen Vorlagen-Auswahlausdruck an, um zu bestimmen, welche Vorlage für die erforderlichen Datentransformationen verwendet werden soll.

Sie können Datenzuordnungen verwenden, um Daten aus einer Routenanforderung einer Backend-Integration zuzuordnen. Weitere Informationen hierzu finden Sie unter Datenmapping für WebSocket APIs einrichten.

Zuweisungsvorlagen und Modelle

Eine Zuweisungsvorlage ist ein in Velocity Template Language (VTL) ausgedrücktes Skript, dass mithilfe von JSONPath-Ausdrücken auf die Nutzlast angewendet wird. Weitere Informationen über API Gateway-Zuordnungsvorlagen finden Sie unter Grundlegendes zu Zuweisungsvorlagen.

Die Nutzlast kann ein dem JSON-Schema Entwurf 4 entsprechendes Datenmodell umfassen. Sie müssen kein Modell definieren, um eine Zuweisungsvorlage zu erstellen. Ein Modell kann Ihnen jedoch bei der Erstellung einer Vorlage helfen, da API Gateway einen Vorlagenentwurf auf der Grundlage eines bereitgestellten Modells generiert. Weitere Informationen über API Gateway-Modelle finden Sie unter Datenmodelle.

Vorlagen-Auswahlausdrücke

Um eine Nutzlast mit einer Zuordnungsvorlage zu transformieren, geben Sie in einer Integrationsanfrage oder Integrationsantwort einen Ausdruck für die WebSocket API-Vorlagenauswahl an. Durch Auswerten dieses Ausdrucks wird die Eingabe- oder Ausgabevorlage (falls vorhanden) bestimmt, die zum Transformieren des Anforderungstexts in den Integrationsanforderungstext (über eine Eingabevorlage) oder des Integrationsantworttext in den Routenantworttext (über eine Ausgabevorlage) verwendet werden soll.

Integration.TemplateSelectionExpression unterstützt ${request.body.jsonPath} und statische Werte.

IntegrationResponse.TemplateSelectionExpression unterstützt ${request.body.jsonPath}, ${integration.response.statuscode}, ${integration.response.header.headerName}, ${integration.response.multivalueheader.headerName} und statische Werte.

Integrationsantwort-Auswahlausdrücke

Wenn Sie eine Integrationsantwort für eine WebSocket API einrichten, können Sie optional einen Auswahlausdruck für eine Integrationsantwort angeben. Dieser Ausdruck bestimmt, welche IntegrationResponse ausgewählt werden sollte, wenn eine Integration zurückgegeben wird. Der Wert dieses Ausdrucks wird zurzeit durch API Gateway eingeschränkt, wie nachfolgend definiert. Beachten Sie, dass dieser Ausdruck nur für Nicht-Proxy-Integrationen relevant ist. Eine Proxy-Integration übergibt die Antwortnutzlast einfach ohne Modellierung oder Modifikation an die aufrufende Methode zurück.

Im Gegensatz zu den anderen vorhergehenden Auswahlausdrücken unterstützt dieser Ausdruck derzeit ein Musterabgleich-Format. Der Ausdruck sollte in Schrägstriche verpackt werden.

Derzeit ist der Wert je nach fixier integrationType:

• Für Lambda-basierte Integrationen lautet er $integration.response.body.errorMessage.

• Für HTTP- und MOCK-Integrationen ist dies $integration.response.statuscode.

• Für HTTP_PROXY und AWS_PROXY wird der Ausdruck nicht verwendet, da Sie anfordern, dass die Nutzlast über die aufrufende Methode übergeben wird.