Files
opsxapi/apps/server/internal/docs/content/08-websocket.md
T
logan dec66db5aa feat: OpsxAPI v1.0 全协议接口工作台
- 六协议调试:HTTP/GraphQL/WebSocket/SSE/Socket.IO/MQTT
- 集合树/多标签/多环境变量/历史记录,localStorage 持久化
- 导入:OpenAPI 2/3/3.1、Postman、Apifox、Apipost、cURL、HAR、
  Insomnia、Hoppscotch、Markdown(自动识别,21 个单测覆盖)
- 导出:OpenAPI 3.0 JSON/YAML、Postman v2.1、Markdown 文档、
  全量备份;单请求生成 cURL/fetch/Python/Go 代码
- Gin 服务:HTTP 代理、NDJSON 流式代理(SSE 透传)、
  WebSocket 隧道(浏览器自定义握手 Header)
- 内置产品官网 /home 与用户文档站 /docs(SSR,随二进制交付)
- lucide 图标体系 + 品牌标识(Logo/favicon),明暗双主题
- 环境变量:彩色徽标切换器、管理弹窗、{{ 自动补全
2026-09-18 00:16:59 +08:00

1.3 KiB
Raw Blame History

连接

  1. 填写 ws:// 或 wss:// 地址。
  2. 点击 连接;状态点变绿(已连接)后即可收发消息。
  3. 再次点击按钮即断开。

消息收发

  • 消息日志:接收(绿)/ 发送(蓝)/ 系统(灰)/ 错误(红)分色展示,顶部统计 ↑↓ 条数与连接时长。
  • 发送框:支持 JSON / 纯文本;⌘/Ctrl + Enter 快速发送;「格式化 JSON」一键美化。

子协议

「握手配置」标签中的子协议填逗号分隔列表,例如:

graphql-transport-ws, v1.json

自定义握手 Header(隧道模式)

浏览器原生 WebSocket 不能携带自定义 Header(如 Authorization、X-API-Key)。OpsxAPI 的处理方式:

  1. 「握手配置」中填写 Header 后,工具自动改走本地 Gin 隧道:
    • 浏览器 → Gin /v1/proxy/ws/attach(普通 WS)
    • Gin → 目标服务器(携带你填的全部 Header)
  2. 不填 Header 时直连目标,零额外开销。

注意:隧道要求本地 Gin 服务(:8787)在运行,即用 ./run.sh web / gui 启动的默认形态。

调试技巧

  • 消息过多时点「清空」;日志上限 500 条,超出自动滚动淘汰。
  • 把常用报文保存在「说明」里,或为不同报文建多个 WS 请求节点。