Apifox WebSocket 调试功能你会用了吗？

素颜马尾好姑娘i 2024-03-22 09:20 82阅读 0赞

在 2.2.32 及更高版本的 Apifox 中，支持对 **[WebSocket API][]** 进行调试。

**[WebSocket][]** 是一种在单个 TCP 连接上进行全双工通信的 API 技术。相比于传统的 HTTP 请求，WebSocket 具有更低的延迟和更高的效率。它适用于需要长时间保持连接并实时传输数据的场景，例如在线游戏、实时聊天等。

### 一、建立连接 ###

WebSocket 通过一个简单的握手过程来建立连接。使用 **[Apifox][]**，只需要在地址栏填写 URL 后点击「连接」按钮，即可完成握手并建立 WebSocket 连接。

1.  在 Apifox 中，点击左侧的「+」按钮，选择「新建 WebSocket 接口（Beta）」；

![0b03495b416a16c34e85e1542e07cdcb.png][]

1.  输入 WebSocket 接口的 URL 以建立连接，**以 ws 或 wss 开头**。同时，你可以自定义握手时所需要传递的参数，比如 Params、Headers、Cookies，以满足鉴权或其他复杂场景。

![cff475c4c108fe6fc9c6936360d8b85a.png][]

1.  点击「连接」，成功后即可无缝地发送和接收消息。

### 二、发送和接收消息 ###

连接后，你可以在 **「Message 」标签下撰写消息**。除了直接撰写 **Text、 JSON、XML、HTML 等文本格式**的消息之外，还可以**通过 Base64 或 Hexadecimal 来撰写二进制格式**的消息。编辑器会根据所选的消息格式，对消息内容进行语法高亮。如果消息是 JSON、XML 或 HTML 格式，还可以对输入的内容进行格式化操作。

Apifox 提供了一个**全新的时间线视图**，在下方的「Messages」种按照时间顺序集中展示连接状态、发送的消息、收到的消息。点击消息之后，可以在右侧查看消息的详情，非常方便。

*  如果消息是文本格式，默认会显示格式化后的消息，也可以手动切换消息格式和编码；
 *  如果消息是二进制格式，默认会显示消息的 Hexdump，也可以查看经过 Base64 编码后的消息和原始消息。

![33e9cc57ac7923e86d239a93dc001fce.png][]

**接口文档，与团队成员协作**

Apifox 出色的接口文档功能在 WebSocket API 上得到了继承。你可以对 Websocket 接口设定状态、责任人、标签，还可以用 Markdown 格式撰写详细的接口说明。  
在完成调试后，你可以点击 「保存」按钮将 WebSocket 接口保存到当前项目内，以便团队内的其他成员进行调试；也可以将 WebSocket 的接口文档分享到团队外部，然后直接在浏览器中查看。

![b3146df014a2617cccc0fdb4b7f8526f.png][]

Apifox 的 WebSocket 接口调试功能正处于 Beta 公开测试阶段，目前的功能只是我们迈出的第一步，后续也会持续迭代更新。Apifox 作为 API 一体化协作平台，希望为不同的 API 技术提供同样优秀的体验。

### 了解更多关于 WebSocket 的知识。 ###

*  **[WebSocket 前后端交互实现详解][WebSocket 1]**
 *  **[WebSocket 实现 SSH 远程命令执行][WebSocket _ SSH]**
 *  **[快速上手：使用 Golang 实现 WebSocket 通信][Golang _ WebSocket]**

[WebSocket API]: https://apifox.com/apiskills/websocket-api-explained/
[WebSocket]: https://apifox.com/apiskills/what-is-websocket/
[Apifox]: https://www.apifox.cn/?utm_source=liam
[0b03495b416a16c34e85e1542e07cdcb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/ece6bdc3afa24ddd916e9edfac6d1988.png
[cff475c4c108fe6fc9c6936360d8b85a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/2ff0da18b55c4a829f722a86b829de6f.png
[33e9cc57ac7923e86d239a93dc001fce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/f07e9f1dc7754a78a7f1ce3c1622e29e.png
[b3146df014a2617cccc0fdb4b7f8526f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/eacc7abe2d4c44cdbfbd5990410a642e.png
[WebSocket 1]: https://apifox.com/apiskills/websocket-interaction/
[WebSocket _ SSH]: https://apifox.com/apiskills/websocket-executes-ssh-commands/
[Golang _ WebSocket]: https://apifox.com/apiskills/golang-websocket-communication/