Files
opsxapi/apps/server/internal/docs/content/01-intro.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

2.2 KiB
Raw Blame History

OpsxAPI 是一款本地优先的专业接口工作台,面向运维与开发,把 HTTP、GraphQL、WebSocket、SSE、Socket.IO、MQTT 六种协议的调试放进同一个窗口。

无需注册、无需联网同步,数据全部保存在本地浏览器(localStorage),导出备份随时带走。

功能总览

能力 说明
六种协议 HTTP / GraphQL / WebSocket / SSE / Socket.IO / MQTT
集合管理 目录树、搜索、右键菜单、拖拽移动、多标签页
多环境变量 {{baseUrl}}、{{token}} 全局替换,一键切换环境
数据导入 OpenAPI/Swagger、Postman、Apifox、Apipost、cURL、HAR、Insomnia、Hoppscotch、Markdown 等
数据导出 OpenAPI 3.0、Postman v2.1、Markdown 文档、全量备份
代码生成 cURL / JavaScript fetch / Python requests / Go net/http
代理能力 本地 Gin 代理绕开 CORS;WebSocket 隧道支持自定义握手 Header
双端形态 浏览器(Web)与桌面端(Tauri)共用同一套界面

支持的协议与场景

协议 典型场景 特色
HTTP / REST 调试 REST 接口、运维平台 API 7 种方法、6 种请求体、3 种鉴权
GraphQL 查询网关、中台接口 Query + Variables 独立编辑
WebSocket 实时推送、行情、IM 自定义握手 Header(经本地隧道)
SSE AI 流式输出、监控事件流 直连失败自动切代理、断点续传
Socket.IO Node 实时应用 事件监听、emit 参数、path/auth 配置
MQTT IoT 设备、消息总线 通配符订阅、QoS、自动重连

为什么选 OpsxAPI

  • 数据主权:所有集合、环境、历史保存在本机,不经过任何第三方服务器。
  • 开箱即用:./run.sh web 一条命令启动;首次打开自带覆盖全部协议的示例集合。
  • 工程友好:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。
  • 轻量克制:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。

提示:想快速感受?直接看下一章《快速开始》,30 秒发出第一个请求。