为 API Gateway 中的 WebSocket API 创建路由

在 WebSocket API 中，传入的 JSON 消息将根据您配置的路由定向到后端集成。（非 JSON 消息将定向到您配置的 $default 路由。）

路由包含一个路由键，这是在评估路由选择表达式时预期的值。routeSelectionExpression 是在 API 级别定义的属性。它指定了预期存在于消息负载中的 JSON 属性。有关路由选择表达式的更多信息，请参阅路由选择表达式。

例如，如果您的 JSON 消息包含一个 action 属性，并且您想要根据此属性执行不同操作，则您的路由选择表达式可能是 ${request.body.action}。您的路由表将通过将 action 属性的值与您在表中定义的自定义路由键值相匹配来指定要执行的操作。

可以使用三个预定义路由：$connect、$disconnect 和 $default。此外，您还可以创建自定义路由。

路由选择表达式

当服务正在为传入消息选择要遵循的路由时，将会对路由选择表达式进行求解。该服务使用其 routeKey 与求解值完全匹配的路由。如果没有匹配项，并且存在具有 $default 路由键的路由，则将选择该路由。如果没有路由与求解值匹配，并且没有 $default 路由，则该服务将返回错误。对于基于 WebSocket 的 API，表达式的格式应为 $request.body.{path_to_body_element}。

例如，假设您要发送以下 JSON 消息：

{
    "service" : "chat",
    "action" : "join",
    "data" : {
        "room" : "room1234"
   }
}

您可能希望根据 action 属性选择 API 的行为。在这种情况下，您可以定义以下路由选择表达式：

$request.body.action

在此示例中，request.body 是指您的消息的 JSON 负载，.action 是 JSONPath 表达式。您可以在 request.body 之后使用任何 JSON 路径表达式，但请记住，结果将会字符串化。例如，如果您的 JSONPath 表达式返回包含两个元素的数组，那么它将显示为字符串 "[item1, item2]"。因此，最好将表达式求解为值而不是数组或对象。

您可以仅使用一个静态值，也可以使用多个变量。下表显示了针对上述负载的示例及其求解结果。

求解结果将用于查找路由。如果存在具有匹配路由键的路由，则将选择该路由来处理消息。如果找不到匹配的路由，则 API Gateway 尝试查找 $default 路由（如果可用）。如果未定义 $default 路由，则 API Gateway 将返回错误。

在 API Gateway 中为 WebSocket API 设置路由

首次创建新的 WebSocket API 时，有三个预定义的路由：$connect、$disconnect 和 $default。您可以使用控制台、API 或 AWS CLI 创建它们。如果需要，您可以创建自定义路由。有关更多信息，请参阅 API Gateway 中的 WebSocket API 概览。

使用 API Gateway 控制台创建路由

使用 AWS CLI 创建路由

以下 create-route 命令创建路由：

aws apigatewayv2 --region us-east-1 create-route --api-id aabbccddee --route-key $default

输出与以下内容类似：

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

为 $connect 指定路由请求设置

当您为 API 设置 $connect 路由时，可以使用以下可选设置为 API 启用授权。有关更多信息，请参阅 $connect 路由。

使用 API Gateway 控制台设置 $connect 路由请求

要使用 API Gateway 控制台为 WebSocket API 设置 $connect 路由请求，请执行以下操作：