Socket.IO

Socket.IO 是一个库，用于在客户端和服务器之间实现低延迟、双向且基于事件的通信。它通过 WebSocket 连接提供实时双向通信通道，并在 WebSocket 不可用时自动回退到 HTTP 长轮询。

前提条件

Apidog 版本 2.7.0 或更高版本

一个 Socket.IO 服务器端点（支持 ws:// 和 wss:// 协议）

创建 Socket.IO 端点

创建新的 Socket.IO 端点

将鼠标悬停在项目左侧面板的 "+" 按钮上

点击 "New Socket.IO"

输入服务器地址

输入服务器地址（例如，ws://localhost:3000）

同时支持 ws:// 和 wss:// 协议

建立连接

点击 "Connect" 按钮连接到服务器

监听事件

打开 Events 标签页，输入你想要监听的事件名称（例如，new message）。对特定事件禁用 Listen，即可停止接收该事件的消息。

事件监听规则

规则	描述
默认事件	系统默认监听 `message` 事件
动态变更	添加或移除事件不会影响现有连接
事件名称变更	更改事件名称会自动停止监听原始事件

发送消息

事件与参数

设置事件和参数

Event: 默认为 message，但你可以自定义（例如，new message）

Argument: 支持 JSON、文本和 Binary 格式

发送消息

点击 "Send" 按钮

查看记录

在时间线中查看带有事件标签的发送记录

确认（Ack）

启用 Ack 选项后，服务器会在接收并处理请求后返回一条回调消息。

多个参数

点击 "+ Add Argument" 以包含其他参数。

当你发送带有多个参数的消息时，时间线会显示类似 "x Args" 的标签。点击它即可展开并查看所有参数。在右侧的标签页之间切换以查看更多详情。

握手请求参数

你可以在 URL、Params、Headers 或 Cookies 中包含请求参数。

客户端版本和握手路径

配置入口

前往 Request 下的 Settings

客户端版本

默认值为 v4。如果服务器使用较旧版本（例如 v2/v3），请手动切换客户端版本

握手路径

默认值为 /socket.io。如果服务器使用自定义路径（例如 /custom），请相应更新该路径

使用变量

Apidog 允许你在参数中包含变量。发送消息时，这些变量会自动替换为其真实值。

保存端点

调试完成后，点击 "Save" 按钮，将 Socket.IO 端点存储到 HTTP 项目的文件夹树中。这使团队成员能够轻松访问、调试和查看端点文档，从而提升协作与效率。

生成端点文档

通过设置 Socket.IO 端点的 status、分配 maintainer 并添加相关 tags，可以轻松管理该端点。你还可以使用 Markdown 编写详细描述。借助 Apidog，你可以生成在线 API 文档，并将 URL 分享给团队，实现无缝协作。

常见问题

如果连接失败该怎么办？

检查清单：

确保服务器正在运行

验证客户端版本与服务器兼容

确保防火墙没有阻止所需端口

没有接收到所有参数？

ACK 未触发？

前提条件#

创建 Socket.IO 端点#

监听事件#

事件监听规则#

发送消息#

事件与参数#

确认（Ack）#

多个参数#

握手请求参数#

客户端版本和握手路径#

使用变量#

保存端点#

生成端点文档#

常见问题#

前提条件

创建 Socket.IO 端点

监听事件

事件监听规则

发送消息

事件与参数

确认（Ack）

多个参数

握手请求参数

客户端版本和握手路径

使用变量

保存端点

生成端点文档

常见问题