在 2.2.32 及更高版本的 Apifox 中,反对对 WebSocket API 进行调试。
WebSocket 是一种在单个 TCP 连贯上进行全双工通信的 API 技术。相比于传统的 HTTP 申请,WebSocket 具备更低的提早和更高的效率。它实用于须要长时间放弃连贯并实时传输数据的场景,例如在线游戏、实时聊天等。
一、建设连贯
WebSocket 通过一个简略的握手过程来建设连贯。应用 Apifox,只须要在地址栏填写 URL 后点击「连贯」按钮,即可实现握手并建设 WebSocket 连贯。
- 在 Apifox 中,点击左侧的「+」按钮,抉择「新建 WebSocket 接口(Beta)」;
- 输出 WebSocket 接口的 URL 以建设连贯,以 ws 或 wss 结尾。同时,你能够自定义握手时所须要传递的参数,比方 Params、Headers、Cookies,以满足鉴权或其余简单场景。
- 点击「连贯」,胜利后即可无缝地发送和接管音讯。
二、发送和接管音讯
连贯后,你能够在 「Message」标签下撰写音讯 。除了间接撰写 Text、JSON、XML、HTML 等文本格式 的音讯之外,还能够 通过 Base64 或 Hexadecimal 来撰写二进制格局 的音讯。编辑器会依据所选的音讯格局,对音讯内容进行语法高亮。如果音讯是 JSON、XML 或 HTML 格局,还能够对输出的内容进行格式化操作。
Apifox 提供了一个 全新的工夫线视图,在下方的「Messages」种依照工夫程序集中展现连贯状态、发送的音讯、收到的音讯。点击音讯之后,能够在右侧查看音讯的详情,十分不便。
- 如果音讯是文本格式,默认会显示格式化后的音讯,也能够手动切换音讯格局和编码;
- 如果音讯是二进制格局,默认会显示音讯的 Hexdump,也能够查看通过 Base64 编码后的音讯和原始音讯。
接口文档,与团队成员合作
Apifox 杰出的接口文档性能在 WebSocket API 上失去了继承。你能够对 Websocket 接口设定状态、责任人、标签,还能够用 Markdown 格局撰写具体的接口阐明。
在实现调试后,你能够点击「保留」按钮将 WebSocket 接口保留到以后我的项目内,以便团队内的其余成员进行调试;也能够将 WebSocket 的接口文档分享到团队内部,而后间接在浏览器中查看。
Apifox 的 WebSocket 接口调试性能正处于 Beta 公开测试阶段,目前的性能只是咱们迈出的第一步,后续也会继续迭代更新。Apifox 作为 API 一体化合作平台,心愿为不同的 API 技术提供同样优良的体验。
理解更多对于 WebSocket 的常识。
- WebSocket 前后端交互实现详解
- WebSocket 实现 SSH 近程命令执行
- 疾速上手:应用 Golang 实现 WebSocket 通信