跳到主要内容

设计

提示

8.1.10之前的版本将不再支持Websocket、Socket.IO接口的新建和更新。如果需要调试Websocket、Socket.IO需要升级至最新版本（8.1.10及之后） 在8.1.10之前的版本中创建的Websocket、Socket.IO接口数据在升级后不会丢失，可正常调试使用。

在Apipost中 设计/预览 Websocket接口文档​

在Apipost中除了可以快速调试Websocket（参照文档），还可以将调试过程中的数据快速生成一份Websocket接口文档，只需将tab切换至设计页面即可

也可以直接设计一份Websocket接口文档，可按以下步骤进行。

image.png

步骤1：创建一个新的请求​

打开Apipost，点击左侧菜单中的“+”按钮，创建一个新的请求。 在请求类型下拉菜单中，选择WebSocket。

image.png

步骤2：设置WebSocket基本信息​

在URL框中，输入Websocket服务器的URL。例如，wss://echo.websocket.org

  • 请确保替换成您的实际Websocket服务器地址和端口。
  • 并注意使用 ws:// 或 wss:// 开头的地址

也可以对WebSocket进行tag标记，文本说明，或者添加扩展属性字段（参照文档）

image.png

步骤3：设置Websocket的请求参数信息​

可以设置连接Websocket的请求头、请求参数、以及其他设置的一些信息条件

image.png

步骤4：设计Websocket消息流，以便生成文档​

您可以在这里设计Websocket消息的请求和响应内容。

image.png

其他：在调试时保存的响应示例也会在展示出来​

在响应区，你可以快速的将当前的响应内容保存为某个消息的响应示例，以便之后生成一份更加完整的接口文档，参考文档

image.png

image.png

image.png