Apifox作为一款强大的API一体化协作平台，不仅支持传统的HTTP接口，也对WebSocket这一重要的实时通信协议提供了出色的测试支持。

WebSocket概念和Apifox支持

WebSocket是一种在单个TCP连接上进行全双工通信的协议，特别适用于需要长时间保持连接并实时传输数据的场景，例如：

即时通讯：如在线聊天、直播弹幕。

实时数据推送：如金融行情、在线游戏、IoT设备监控。

在线协作：如多人在线文档编辑。

Apifox的WebSocket测试支持：

Apifox从 v2.2.32 开始支持WebSocket接口测试（Beta），并持续增强功能。要使用完整的WebSocket功能，建议使用Apifox客户端（而非网页版）。

WebSocket接口测试详解

1. 准备工作和创建接口

新建接口：在项目中点击左侧的「+」按钮，选择「新建WebSocket接口（Beta）」。

配置服务器地址：在地址栏中输入WebSocket服务器的URL，以ws（非加密）或wss（SSL 加密）开头。

2. 建立连接和握手配置

建立连接：填写正确的 URL 后，点击「连接」按钮，Apifox会尝试和服务器建立连接。连接状态及详细信息会实时显示在控制台面板中。

配置握手参数 (主要步骤)：WebSocket连接通过 HTTP 升级请求建立握手，许多鉴权信息在这个阶段传递。

参数类型：你可以在连接前或断开后，配置Params（查询参数）、Headers（请求头）、Cookies等。

用途：用于传递 API 令牌 (Token)、身份认证信息等。

重要提示：一旦连接建立，将无法再修改这些握手参数。若需调整，必须先断开连接。

3. 消息发送、接收和查看

连接成功后，主要的通信环节便开始了一收一发，皆在掌握。

发送消息：

格式丰富：在「Message」标签下，你可以编写Text、JSON、XML、HTML等文本格式的消息。对于二进制消息，Apifox支持通过 Base64 或 Hexadecimal（十六进制） 方式撰写。

编辑器友好：编辑器会根据所选消息格式进行语法高亮，并对JSON、XML、HTML等内容提供格式化操作。

使用变量：消息内容中支持使用Apifox的环境变量，格式为 {{变量名}}，发送时会被自动替换。

查看消息：

时间线视图：Apifox在下方的「Messages」面板中，按照时间顺序集中展示所有动态，包括连接状态、已发送的消息、接收到的消息。为分析交互流程提供便利。

消息详情：点击任意一条消息，可在右侧查看详情。

对于文本消息，默认会尝试进行格式化显示，你也可以手动切换查看原始格式或不同编码。

对于二进制消息，默认会以Hexdump（十六进制转储）形式展示，也支持查看Base64编码后的内容或原始消息。

测试技巧应用

1. Socket.IO 接口测试

Apifox同样支持测试基于Socket.IO 库的接口（确保Apifox版本 ≥ 2.7.0）。操作和标准WebSocket配置：

事件监听：在「Events」标签页，你可以动态添加或移除需要监听的事件（默认已监听message 事件）。修改事件名会自动解除原事件监听并订阅新事件。

ACK确认模式：发送消息时，可以勾选「Ack」选项。这个时，Apifox会等待服务端调用callback() 函数，并自动捕获和显示确认消息。

多参数发送：支持为一条消息添加多个参数标签页，来应对复杂的发送场景。

客户端配置：在「设置」面板中，需要保证Apifox的Socket.IO客户端版本及握手路径和服务端保持一致，否则可能导致连接失败。

2. 协作和文档化

Apifox的优势是将测试工具和协作平台深度融合。

保存接口：调试完成后，点击「保存」按钮，可以将WebSocket接口保存到项目的目录树中，方便团队其他成员直接使用或查看。

生成接口文档：你可以为WebSocket接口设置状态、责任人、标签，并用Markdown格式撰写详细的接口说明。Apifox会生成在线文档，通过 URL 即可分享。

常见问题排查 

连接失败怎么办？

确认服务端是否正常运行。

核对 URL 的协议头（ws 或 wss）是否正确。

检查握手参数（如Headers中的认证信息）是否配置正确且完整。

对于Socket.IO，检查客户端版本和握手路径是否和服务端匹配。

确认防火墙或网络策略是否开放了相应端口。

ACK请求没有收到响应？

请检查服务端是否正确实现了callback函数的调用。例如在Node.js中：

javascript

socket.on('event', (data, callback) => {

  // ... 处理逻辑

  callback({ status: 'received' }); // 必须调用 callback

});

Apifox支持WebSocket接口的Mock吗？

目前Apifox的Mock功能暂不支持WebSocket接口。

为什么WebSocket接口不需要像 HTTP 接口那样设置响应校验？

因为WebSocket连接一旦建立，其状态码固定为101（Switching Protocols），校验意义不大。测试的重点应放在消息的收发逻辑和内容上。