Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

在 API Gateway 中创建 WebSocket API

您可以通过使用 AWS CLI create-api 命令或通过在 AWS 开发工具包中使用 CreateApi 命令,在 API Gateway 控制台中创建 WebSocket API。以下过程说明如何创建新的 WebSocket API。

注意

WebSocket API 仅支持 TLS 1.2。不支持早期 TLS 版本。

使用 AWS CLI 命令创建 WebSocket API

使用 AWS CLI 创建 WebSocket API 需要调用 create-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" }

使用 API Gateway 控制台创建 WebSocket API

您可以通过选择 WebSocket 协议并为 API 命名来在控制台中创建 WebSocket API。

重要

创建 API 后,您无法更改为其选择的协议。无法将 WebSocket API 转换为 REST API,反之亦然。

使用 API Gateway 控制台创建 WebSocket API

  1. 登录到 API Gateway 控制台,然后选择 Create API (创建 API)

  2. Choose the protocol (选择协议) 下面,选择 WebSocket

  3. Create a new API (创建新 API) 下面,选择 New API (新建 API)

  4. Settings (设置) 下面的 API name (API 名称) 字段中,键入 API 的名称,例如,PetStore

  5. 为 API 输入 Route Selection Expression (路由选择表达式),例如,$request.body.action

    有关路由选择表达式的更多信息,请参阅路由选择表达式

  6. 如果需要,为 API 键入 Description (描述)

  7. 选择 Create API (创建 API)