WebSocket APIs Im API Gateway bereitstellen

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.

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.

Nachdem Sie Ihre WebSocket API erstellt haben, müssen Sie sie bereitstellen, damit Ihre Benutzer sie aufrufen können.

Zum Bereitstellen einer API erstellen Sie eine API-Bereitstellung und verknüpfen sie mit einer Stufe. Jede Stufe ist ein Snapshot der API und wird für Client-Apps zum Aufrufen verfügbar gemacht.

Um eine bereitgestellte WebSocket API aufzurufen, sendet der Client eine Nachricht an die URL der API. Die URL wird anhand des Hostnamens und der Stufennummer der API bestimmt.

Unter Verwendung des Standard-Domainnamens der API hat die URL (zum Beispiel) einer WebSocket API in einer bestimmten Phase ({stageName}) das folgende Format:

wss://{api-id}.execute-api.{region}.amazonaws.com/{stageName}

Um die URL der WebSocket API benutzerfreundlicher zu gestalten, können Sie einen benutzerdefinierten Domainnamen (z. B.api.example.com) erstellen, der den Standard-Hostnamen der API ersetzt. Der Konfigurationsprozess ist derselbe wie für REST APIs. Weitere Informationen finden Sie unter Benutzerdefinierter Domainname für öffentliches REST APIs in API Gateway.

Stufen ermöglichen eine robuste Versionskontrolle Ihrer API. Sie können beispielsweise eine API für eine test- und eine prod-Stufe bereitstellen und die test-Stufe als Test-Build und die prod-Stufe als stabilen Build verwenden. Nachdem die Aktualisierungen den Test bestanden haben, können Sie die test-Stufe auf prod hochstufen. Die Hochstufung kann durch die erneute Bereitstellung der API für die prod-Stufe erfolgen. Weitere Informationen zu Stufen finden Sie unter Einrichten einer Stufe für eine REST-API in API Gateway.

Erstellen Sie eine WebSocket API-Bereitstellung mit dem AWS CLI

Der Befehl create-deployment erstellt eine Bereitstellung:

aws apigatewayv2 --region us-east-1 create-deployment --api-id aabbccddee

Die Ausgabe sieht wie folgt aus:

{
    "DeploymentId": "fedcba",
    "DeploymentStatus": "DEPLOYED",
    "CreatedDate": "2018-11-15T06:49:09Z"
}

Die bereitgestellte API kann erst aufgerufen werden, wenn Sie die Bereitstellung einer Stufe zugeordnet haben. Sie können eine neue Stufe erstellen oder eine Stufe wiederverwenden, die Sie zuvor erstellt haben.

Der folgende Befehl create-stage erstellt eine neue Phase und ordnet sie der Bereitstellung zu:

aws apigatewayv2 --region us-east-1 create-stage --api-id aabbccddee --deployment-id fedcba --stage-name test

Die Ausgabe sollte wie folgt aussehen:

{
    "StageName": "test",
    "CreatedDate": "2018-11-15T06:50:28Z",
    "DeploymentId": "fedcba",
    "DefaultRouteSettings": {
        "MetricsEnabled": false,
        "ThrottlingBurstLimit": 5000,
        "DataTraceEnabled": false,
        "ThrottlingRateLimit": 10000.0
    },
    "LastUpdatedDate": "2018-11-15T06:50:28Z",
    "StageVariables": {},
    "RouteSettings": {}
}

Sie können auch eine vorhandene Phase wiederverwenden, indem Sie die deploymentId Eigenschaft der Phase mit der neu erstellten Bereitstellungs-ID () deployment-id aktualisieren. Mit dem folgenden Befehl update-stage wird die Bereitstellungs-ID der Phase aktualisiert:

aws apigatewayv2 update-stage --region region \
    --api-id api-id \ 
    --stage-name stage-name \ 
    --deployment-id deployment-id

Erstellen Sie eine WebSocket API-Bereitstellung mit der API Gateway Gateway-Konsole

So verwenden Sie die API Gateway Gateway-Konsole, um eine Bereitstellung für eine WebSocket API zu erstellen: