

# 使用 `wscat` 连接到 WebSocket API 并向其发送消息


`[wscat](https://www.npmjs.com/package/wscat)` 实用程序是一个方便的工具，用于测试您已在 API Gateway 中创建和部署的 WebSocket API。您可以按如下方式安装和使用 `wscat`：

1. 从 [https://www.npmjs.com/package/wscat](https://www.npmjs.com/package/wscat) 中下载 `wscat`。

1. 通过运行以下命令安装 `wscat`：

   ```
   npm install -g wscat
   ```

1. 要连接到 API，请运行 `wscat` 命令，如以下示例所示。请注意，此示例假定 `Authorization` 设置是 `NONE`。

   ```
   wscat -c wss://aabbccddee.execute-api.us-east-1.amazonaws.com/test/
   ```

   您需要将 `aabbccddee` 替换为实际的 API ID，该 ID 显示在 API Gateway 控制台中或由 Amazon CLI [https://docs.amazonaws.cn/cli/latest/reference/apigatewayv2/create-api.html](https://docs.amazonaws.cn/cli/latest/reference/apigatewayv2/create-api.html) 命令返回。

   此外，如果您的 API 位于 `us-east-1` 以外的区域，则需要替换正确的区域。

1. 要测试您的 API，请在连接时输入以下消息：

   ```
   {"{jsonpath-expression}":"{route-key}"}
   ```

   其中 *\$1jsonpath-expression\$1* 是一个 JSONPath 表达式，*\$1route-key\$1* 是 API 的路由键。例如：

   ```
   {"action":"action1"}
   {"message":"test response body"}
   ```

   有关 JSONPath 的更多信息，请参阅 [JSONPath](https://goessner.net/articles/JsonPath/) 或[适用于 Java 的 JSONPath](https://github.com/json-path/JsonPath)。

1. 要从 API 断开连接，请输入 `ctrl-C`。