WebSocket 是一种 API 技术，可通过单个 TCP 连接实现全双工通信。与传统 HTTP 请求相比，WebSocket 具有更低的延迟和更高的效率，非常适合需要持久连接和实时数据传输的场景，例如在线游戏、实时聊天、实时通知和协作应用。Apidog 2.2.34 及更高版本支持 WebSocket API 管理。
创建 WebSocket 端点#
你可以在 HTTP 项目中创建 WebSocket 端点。1.
点击左侧的 "+" 按钮，然后选择 "New WebSocket"
2.
输入 WebSocket 服务器 URL，以 ws 或 wss 开头
4.
如需断开 WebSocket 端点连接，请点击 "Disconnect"
为了获得最佳体验并使用 WebSocket API 的完整功能集，我们建议使用 Apidog 客户端。
发送消息#
建立 WebSocket 连接后，你可以在 Message 标签页下编写消息。支持的消息格式#
| 格式类型 | 格式 |
|---|
| 文本格式 | Text, JSON, XML, HTML |
| 二进制格式 | Base64, Hexadecimal |
编辑器会根据所选消息格式对消息内容应用语法高亮。对于 JSON、XML 或 HTML 格式，你还可以格式化输入内容。查看消息#
Messages 部分会 按时间顺序显示连接状态、已发送消息和已接收消息。| 消息类型 | 默认显示 | 其他选项 |
|---|
| 文本格式 | 格式化后的消息 | 手动切换消息格式和编码 |
| 二进制格式 | Hexdump | 查看 Base64 编码或原始消息 |
添加握手请求参数#
你可以自定义 WebSocket 握手期间所需的参数，例如 Params、Headers 和 Cookies，以适配身份验证或其他复杂场景。连接建立后，无法修改握手请求参数。必须在建立连接之前或断开连接之后进行配置。
使用变量#
你可以在 WebSocket 连接的握手和消息中使用 Apidog 变量。了解更多关于使用变量的信息。API 文档#
你可以为 WebSocket API 设置状态、负责人和标签，并以 Markdown 格式提供详细的 API 描述。你还可以与外部团队共享 WebSocket API 文档，他们可以直接在浏览器中查看。保存 API#
调试完成后，点击 "Save" 按钮，将 WebSocket API 保存到 HTTP 项目的目录树中。这样，其他团队成员就可以调试或查看 API 文档。FAQ#
对于 WebSocket 请求，建立连接时 HTTP 状态码必须为 101，表示协议升级成功。因此，通常不需要验证状态码。
