WebSocket-APIs in API Gateway erstellen - Amazon API Gateway
Erstellen einer WebSocket-API mit AWS CLI-BefehlenWebSocket-API über die API Gateway-Konsole erstellen

WebSocket-APIs in API Gateway erstellen

Sie können eine WebSocket-API mit dem AWS CLI-Befehl create-api In der API-Gateway-Konsole, oder im AWS-SDK mit dem CreateApi-Befehl erstellen. Das folgende Verfahren zeigt, wie Sie eine neue WebSocket-API erstellen.

Anmerkung

WebSocket-APIs unterstützen ausschließlich TLS 1.2. und TLS 1.3. Frühere TLS-Versionen werden nicht unterstützt.

Erstellen einer WebSocket-API mit AWS CLI-Befehlen

Der folgende create-api-Befehl erstellt eine API mit dem Routen-Auswahlausdruck $request.body.action:

aws apigatewayv2 --region us-east-1 create-api --name "myWebSocketApi3" --protocol-type WEBSOCKET --route-selection-expression '$request.body.action'

Die Ausgabe sollte wie folgt aussehen:

{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi3",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}

WebSocket-API über die API Gateway-Konsole erstellen

Sie können eine WebSocket-API in der Konsole erstellen, indem Sie das WebSocket-Protokoll auswählen und einen Namen für die API eingeben.

Wichtig

Sobald Sie die API erstellt haben, können Sie das für sie ausgewählte Protokoll nicht mehr ändern. Es ist nicht möglich, eine WebSocket-API in eine REST-API oder umgekehrt zu konvertieren.

So erstellen Sie eine WebSocket-API über die API Gateway-Konsole:

  1. Melden Sie sich bei der API Gateway-Konsole an und wählen Sie Create API (API erstellen).

  2. Wählen Sie unter WebSocket API die Option Create (Erstellen). Es werden nur regionale Endpunkte unterstützt.

  3. Geben Sie unter API-Name den Namen Ihrer API ein.

  4. Geben Sie unter Ausdruck für die Routenauswahl einen Wert ein. Beispiel, $request.body.action.

    Weitere Informationen zu Routen-Auswahlausdrücken finden Sie unter Routen-Auswahlausdrücke.

  5. Führen Sie eine der folgenden Aufgaben aus:

    • Wählen Sie Leere API erstellen aus, wenn Sie eine API ohne Routen erstellen möchten.

    • Klicken Sie auf Weiter, um Ihrer API Routen anzuhängen.

    Sie können Routen anhängen, nachdem Sie Ihre API erstellt haben.