在 WebSocket API Gateway 中建立 API - Amazon API Gateway
使用 AWS CLI 命令建立 WebSocket API使用 WebSocket API Gateway 主控台建立 API

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

在 WebSocket API Gateway 中建立 API

您可以使用 WebSocket AWS CLI create-api 命令或在 SDK 中使用命令，在 API Gate way 主控台中建立 API。CreateApi AWS 下列程序顯示如何建立新 WebSocket API。

注意

WebSocket API 只支援 TLS 1.2 和 TLS 1.3。不支援舊版 TLS。

使用 AWS CLI 命令建立 WebSocket API

使用 AWS CLI 需要呼叫 create- WebSocket api 命令來建立 API，如下列範例所示，這會使用$request.body.action路由選取運算式建立 API：

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

輸出範例：

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

使用 WebSocket API Gateway 主控台建立 API

您可以通過選擇 WebSocket 協議並為 WebSocket API 命名來在控制台中創建 API。

重要

一旦建立 API 後，您無法更改您選擇的通訊協定。沒有辦法將 WebSocket API 轉換為 REST API，反之亦然。

若要使用 WebSocket API Gateway 主控台建立 API

  1. 登入 API Gateway 主控台，然後選擇 Create API (建立 API)。

  2. 在 [WebSocket API] 下，選擇 [建置]。僅支援區域端點。

  3. 針對 API 名稱，輸入您 API 的名稱。

  4. 針對路由選擇表達式輸入值。例如 $request.body.action。

    如需路由選擇表達式的詳細資訊，請參閱路由選擇表達式。

  5. 執行以下任意一項：

    • 選擇建立空白 API 以建立沒有路由的 API。

    • 選擇下一步將路由附加到您的 API。

    您可以在建立 API 之後附加路由。