Richten Sie Routenantworten für eine WebSocket API in API Gateway ein

WebSocket Routen können für bidirektionale oder unidirektionale Kommunikation konfiguriert werden. API-Gateway übergibt die Backend-Antwort nicht über die Routenantwort, es sei denn, Sie haben eine Routenantwort eingerichtet.

Anmerkung

Sie können die $default Routenantwort nur für WebSocket APIs definieren. Sie können eine Integrationsantwort verwenden, um die Antwort von einem Backend-Service zu manipulieren. Weitere Informationen finden Sie unter Übersicht über Integrationsantworten.

Sie können Routenantworten und Antwortauswahlausdrücke mithilfe der API Gateway Gateway-Konsole AWS CLI oder eines AWS SDK konfigurieren.

Weitere Informationen über Routenantwort-Auswahlausdrücke finden Sie unter Routenantwort-Auswahlausdrücke.

Routenantwort mit der API Gateway-Konsole einrichten

Nachdem Sie eine WebSocket API erstellt und eine Proxy-Lambda-Funktion an die Standardroute angehängt haben, können Sie die Routenantwort mit der API Gateway Gateway-Konsole einrichten:

1. Melden Sie sich bei der API Gateway Gateway-Konsole an und wählen Sie eine WebSocket API mit einer Proxy-Lambda-Funktionsintegration auf der $default Route aus.

2. Wählen Sie unter Routes (Routen) die $default-Route aus.

3. Wählen Sie Enable two-way communication (Bidirektionale Kommunikation aktivieren).

4. Klicken Sie auf Deploy API.

5. Stellen Sie Ihre API für eine Stufe bereit.

Stellen Sie mit dem folgenden wscat-Befehl eine Verbindung mit Ihrer API her. Mehr über wscat erfahren Sie unter Wird verwendetwscat, um eine Verbindung zu einer WebSocket API herzustellen und Nachrichten an diese zu senden.

wscat -c wss://api-id.execute-api.us-east-2.amazonaws.com/test

Drücken Sie die Eingabetaste, um die Standardroute aufzurufen. Der Hauptteil Ihrer Lambda-Funktion sollte zurückgegeben werden.

Richten Sie eine Routenantwort mit dem ein AWS CLI

Um eine Routenantwort für eine WebSocket API mithilfe von einzurichten AWS CLI, rufen Sie den create-route-responseBefehl auf, wie im folgenden Beispiel gezeigt. Sie können die API-ID und Routing-ID identifizieren, indem Sie get-apis und get-routes aufrufen.

aws apigatewayv2 create-route-response \
    --api-id aabbccddee \
    --route-id 1122334  \
    --route-response-key '$default'

Beispielausgabe:

{
    "RouteResponseId": "abcdef",
    "RouteResponseKey": "$default"
}