如何使用 Apifox 调试 WebSocket API

如何使用 Apifox 调试 WebSocket API

今天,我们很高兴地宣布 Apifox 现在已支持 WebSocket API。

在 2.2.32 及更高版本的 Apifox 中,可以对 WebSocket API 进行调试了。WebSocket 是一种在单个 TCP 连接上进行全双工通信的 API 技术。相比于传统的 HTTP 请求,WebSocket 具有更低的延迟和更高的效率。它适用于需要长时间保持连接并实时传输数据的场景,例如在线游戏、实时聊天等。

在最新版本的 Apifox 中,你可以在项目中点击左侧的「+」按钮,选择「新建 WebSocket 接口(Beta)」,输入 WebSocket 接口的 URL 以建立连接,然后无缝地发送和接收消息。

建立连接

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

此外,你也可以自定义握手时所需要传递的参数,比如 Params、Headers、Cookies,以满足鉴权或其他复杂场景。

发送和接收消息

连接后,你可以在 Message 标签下撰写消息。除了直接撰写 Text、 JSON、XML、HTML 等文本格式的消息之外,还可以通过 Base64 或 Hexadecimal 来撰写二进制格式的消息。

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

接口文档

Apifox 出色的接口文档功能在 WebSocket API 上得到了继承。你可以对 Websocket 接口设定状态、责任人、标签,还可以用 Markdown 格式撰写详细的接口说明。

当然,你可以将 WebSocket 的接口文档分享到团队外部,然后直接在浏览器中查看。

保存接口,与团队成员协作

在完成调试后,你可以点击 「保存」按钮将 WebSocket 接口保存到当前项目内,以便团队内的其他成员进行调试。

下一步

Apifox 的 WebSocket API 支持目前正处在 Beta 公开测试阶段,目前的功能只是我们迈出的第一步。Apifox 作为 API 一体化协作平台,希望为不同的 API 技术提供同样优秀的体验。

此外,Apifox 对其他 API 技术的支持工作也在开展中,感谢你的支持。同时 Apifox  最近发布了新版本,欢迎更新使用:《Apifox 2 月产品更新亮点解读》。

订阅
qrcode

订阅

随时随地获取 Apifox 最新动态