教程：利用 AWS 集成创建 WebSocket API

创建 AWS CloudFormation 堆栈

1. 打开 AWS CloudFormation 控制台，地址：https://console.aws.amazon.com/cloudformation。

2. 选择创建堆栈，然后选择使用新资源(标准)。

3. 对于指定模板，选择上传模板文件。

4. 选择您下载的模板。

5. 选择下一步。

6. 对于堆栈名称，输入 websocket-step-functions-tutorial，然后选择下一步。

7. 对于配置堆栈选项，请选择下一步。

8. 对于功能，请确认 AWS CloudFormation 可以在您的账户中创建 IAM 资源。

9. 选择提交。

创建 WebSocket API

1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

2. 选择创建 API。对于 WebSocket API，选择构建。

3. 对于 API 名称，请输入 websocket-step-functions-tutorial。

4. 对于路由选择表达式，输入 request.body.action。

   路由选择表达式确定当客户端发送消息时 API Gateway 调用的路由。

5. 选择下一步。

6. 对于预定义路由，选择添加 $connect、添加 $disconnect、添加 $default。

   $connect 和 $disconnect 路由是 API Gateway 在客户端连接到 API 或断开与 API 的连接时自动调用的特殊路由。当没有其它路由与请求匹配时，API Gateway 调用 $default 路由。创建 API 后，您将创建一个连接到 Step Functions 的自定义路由。

7. 选择下一步。

8. 对于 $connect 的集成，请执行以下操作：

   1. 对于集成类型，选择 Lambda。

   2. 对于 Lambda 函数，选择您在步骤 1 中使用 AWS CloudFormation 创建的相应 $connect Lambda 函数。Lambda 函数名称应该以 websocket-step 开头。

9. 对于 $disconnect 的集成，请执行以下操作：

   1. 对于集成类型，选择 Lambda。

   2. 对于 Lambda 函数，选择您在步骤 1 中使用 AWS CloudFormation 创建的相应 $disconnect Lambda 函数。Lambda 函数名称应该以 websocket-step 开头。

10. 对于 $default 的集成，请选择模拟。

    在模拟集成中，API Gateway 在没有集成后端的情况下管理路由响应。

11. 选择下一步。

12. 查看 API Gateway 为您创建的阶段。默认情况下，API Gateway 会创建名为生产的阶段，然后自动将您的 API 部署到该阶段。选择下一步。

13. 选择创建和部署。

创建 Lambda 授权方

1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

2. 在主导航窗格中，选择授权方。

3. 选择创建授权方。

4. 对于授权方名称，输入 LambdaAuthorizer。

5. 对于授权方 ARN，输入由 AWS CloudFormation 模板创建的授权方的名称。名称应以 websocket-step-functions-tutorial-AuthorizerHandler 开头。

   注意

   我们建议不要为生产 API 使用此示例授权方。

6. 对于身份来源类型，选择标头。对于键，输入 Authorization。

7. 选择创建授权方。

将授权方附加到 $connect 路由

1. 在主导航窗格中，选择路由。

2. 选择 $connect 路由。

3. 在路由请求设置部分中，选择编辑。

4. 对于授权，请选择下拉菜单，然后选择您的请求授权方。

5. 选择保存更改。

创建模拟请求

1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

2. 选择 $default 路由，然后选择集成请求选项卡。

3. 对于请求模板，请选择编辑。

4. 对于模板选择表达式，输入 200，然后选择编辑。

5. 在集成请求选项卡上，对于请求模板，选择创建模板。

6. 对于模板密钥，输入 200。

7. 对于生成模板，输入以下映射模板：

   {"statusCode": 200}

   选择创建模板。

   结果应该类似以下内容：

   

8. 在 $default 路由窗格中，选择启用双向通信。

9. 选择集成响应选项卡，然后选择创建集成响应。

10. 对于响应密钥，输入 $default。

11. 对于模板选择表达式，输入 200。

12. 选择创建响应。

13. 在响应模板下，选择创建模板。

14. 对于模板密钥，输入 200。

15. 对于响应模板，输入以下映射模板：

    {"Use the sendmessage route to send a message. Connection ID: $context.connectionId"}

16. 选择创建模板。

    结果应该类似以下内容：

    

创建非代理集成

1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

2. 选择创建路由。

3. 对于路由键，请输入 sendmessage。

4. 对于集成类型，选择 AWS 服务。

5. 对于 AWS 区域，输入您部署了 AWS CloudFormation 模板的区域。

6. 对于 AWS 服务，选择 Step Functions。

7. 对于 HTTP 方法，选择 POST。

8. 对于操作名称，输入 StartExecution。

9. 对于执行角色，输入由 AWS CloudFormation 模板创建的执行角色。名称应为 WebsocketTutorialApiRole。

10. 选择创建路由。

创建映射模板

1. 选择 sendmessage 路由，然后选择集成请求选项卡。

2. 在请求模板部分中，选择编辑。

3. 对于模板选择表达式，输入 \$default。

4. 选择编辑。

5. 在请求模板部分，选择创建模板。

6. 对于模板密钥，输入 \$default。

7. 对于生成模板，输入以下映射模板：

   #set($domain = "$context.domainName")
   #set($stage = "$context.stage")
   #set($body = $input.json('$'))
   #set($getMessage = $util.parseJson($body))
   #set($mymessage = $getMessage.message)
   {
   "input": "{\"domain\": \"$domain\", \"stage\": \"$stage\", \"message\": \"$mymessage\"}",
   "stateMachineArn": "arn:aws:states:us-east-2:123456789012:stateMachine:WebSocket-Tutorial-StateMachine"
   }

   将 stateMachineArn 替换为由 AWS CloudFormation 创建的状态机的 ARN。

   映射模板执行以下操作：

   • 使用上下文变量 domainName 创建变量 $domain。

   • 使用上下文变量 stage 创建变量 $stage。

     $domain 和 $stage 变量是构建回调 URL 所必需的。

   • 接收传入的 sendmessage JSON 消息，并提取 message 属性。

   • 为状态机创建输入。输入是 WebSocket API 的域和阶段以及来自 sendmessage 路由的消息。

8. 选择创建模板。

   

部署 API

1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

2. 在主导航窗格中，选择路由。

3. 选择部署 API。

4. 对于阶段，选择生产。

5. （可选）对于部署描述，输入描述。

6. 选择部署。

获取您的 API 的调用 URL

1. 选择 API。

2. 选择阶段，然后选择生产。

3. 记下 API 的 WebSocket URL。该 URL 应类似于 wss://abcdef123.execute-api.us-east-2.amazonaws.com/production。

测试与您的 API 的连接

1. 使用以下命令连接到您的 API。首先，通过调用 /ping 路径来测试连接。

   wscat -c wss://abcdef123.execute-api.us-east-2.amazonaws.com/production -H "Authorization: Allow" --slash -P

   Connected (press CTRL+C to quit)

2. 输入以下命令来 ping 控制帧。您可以从客户端使用控制帧来实现保持活动目的。

   /ping

   结果应该类似以下内容：

   < Received pong (data: "")

要测试您的 API

1. 打开一个新终端并使用以下参数再次运行 wscat 命令。

   wscat -c wss://abcdef123.execute-api.us-east-2.amazonaws.com/production -H "Authorization: Allow"

   Connected (press CTRL+C to quit)

2. API Gateway 根据 API 的路由请求选择表达式确定要调用的路由。您的 API 的路由选择表达式是 $request.body.action。因此，当您发送以下消息时，API Gateway 会调用 sendmessage 路由：

   {"action": "sendmessage", "message": "hello, from Step Functions!"}

   与路由关联的 Step Functions 状态机使用消息和回调 URL 调用 Lambda 函数。Lambda 函数调用 API Gateway 管理 API，并将消息发送给所有连接的客户端。所有客户端都会收到以下消息：

   < hello, from Step Functions!

从 API 断开连接

• 按 CTRL+C 以从 API 断开连接。

  当客户端与 API 断开连接时，API Gateway 会调用 API 的 $disconnect 路由。适用于 API 的 $disconnect 路由的 Lambda 集成会从 DynamoDB 中删除连接 ID。

删除 WebSocket API

1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

2. 在 API 页面上，选择您的 websocket-api。

3. 选择操作，选择删除，然后确认您的选择。

删除 AWS CloudFormation 堆栈

1. 打开 AWS CloudFormation 控制台，地址：https://console.aws.amazon.com/cloudformation。

2. 选择您的 AWS CloudFormation 堆栈。

3. 选择删除，然后确认您的选择。