在 API Gateway 中为 WebSocket API 设置路由响应
WebSocket 路由可以配置为双向或单向通信。如果路由具有路由响应,则会将其配置为双向通信。否则,会将它配置为单向通信。路由响应 用于启用双向通信,在其中您的 API 可以在客户端消息的上下文中将响应发送回客户端。
您可以使用 API Gateway 控制台、Amazon CLI 或Amazon开发工具包配置路由响应和响应选择表达式。有关路由响应的更多信息,请参阅调用您的后端集成:$default 路由和自定义路由。
有关路由响应选择表达式的更多信息,请参阅路由响应选择表达式。
使用 API Gateway 控制台设置路由响应
要使用 API Gateway 控制台为 WebSocket API 设置路由响应,请执行以下操作:
-
登录 API Gateway 控制台,选择 API。
-
在 Routes (路由) 中,选择所需路由。
-
在路由概述窗格中选择 Route Response (路由响应)。
-
在 Response Modeling (响应建模) 下面,在 Response Selection Expression (响应选择表达式) 框中,输入所需的响应选择表达式,然后选中复选标记图标。
-
在 Route Responses (路由响应) 下面,在 Response Key (响应键) 下面,选择 Add Response (添加响应)。
注意 目前,WebSocket API 的路由响应中仅支持
$default
。 -
输入响应键名称并选中复选标记图标。
使用 Amazon CLI 设置路由响应
要使用 Amazon CLI 为 WebSocket API 设置路由响应,请调用 create-route-response
命令,如以下示例所示。您可以通过调用 get-apis
和 get-routes
来识别 API ID 和路由 ID。
aws apigatewayv2 create-route-response \ --api-id
aabbccddee
\ --route-id1122334
\ --route-response-key '$default'
输出示例:
{ "RouteResponseId": "abcdef", "RouteResponseKey": "$default" }