Files
opsxapi/apps/server/internal/docs/content/03-interface.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.7 KiB
Raw Blame History

OpsxAPI 主界面分为五个区域:

顶栏

元素 作用
+ 新建 快捷创建各协议请求 / 目录(默认建在第一个集合)
导入 / 导出 打开数据导入、导出对话框
环境选择器 切换当前环境(变量随之生效),「⚙ 环境」管理环境与变量
🌙 / ☀️ 明暗主题切换
⋯ 设置(主题、超时、重置工作区)

左侧集合树

  • 点击请求 → 在标签页中打开;点击目录 → 展开 / 折叠。
  • 右键任意节点:新建、重命名、复制、导出、删除。
  • 拖拽请求或目录到另一个目录,即可移动(支持跨集合)。
  • 顶部搜索框按名称 / 方法 / URL 实时过滤。
  • 底部为历史记录:显示最近请求的状态码与耗时,点击可回跳到对应接口。

标签页栏

同时打开多个接口,中键或 × 关闭;右键支持「关闭其他 / 关闭全部」。正在连接中的实时协议标签会显示呼吸圆点。

请求编辑区(上半部分)

按协议呈现不同编辑器:

协议 标签页
HTTP Params · Body · Headers · Cookies · Auth · 说明
GraphQL Query · Variables · Headers · Auth
WebSocket 消息 · 握手配置 · 说明
SSE 事件流 · 连接配置 · 说明
Socket.IO 事件 · 连接配置 · 说明
MQTT 消息 · Broker / 订阅 · 发布 · 说明

响应区(下半部分)

  • HTTP / GraphQL:响应体(Pretty JSON 高亮)、Raw、响应头,右上角状态 / 耗时 / 大小 / 复制。
  • 实时协议:分色消息日志(接收 · 绿、发送 · 蓝、系统 · 灰、错误 · 红),顶部实时统计收发条数与连接时长。