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

环境要求

组件 版本 用途
Node.js ≥ 20 Web 前端(Vite)
Go ≥ 1.23 本地代理服务(Gin)
Rust + Cargo 可选 仅编译桌面端(Tauri)时需要

启动

git clone <你的仓库地址> opsxapi
cd opsxapi
make install     # 安装依赖(npm install,含桌面端)

./run.sh web     # 启动:Gin(:8787) + Web UI(:5173)

看到下面的输出即可打开浏览器:

[OK] 后端 UP  http://127.0.0.1:8787/health
[OK] Web UP  http://127.0.0.1:5173
命令 说明
./run.sh web 浏览器版(推荐)
./run.sh gui 桌面窗口(Tauri,共用同一 UI)
./run.sh all Web + 桌面一起开
./run.sh status / stop 查看状态 / 停止

30 秒发出第一个请求

  1. 打开 http://127.0.0.1:5173,左侧是内置的「示例集合」。
  2. 点击 HTTP · httpbin → 获取请求回显。
  3. 点击右上角 发送。
  4. 下方响应区显示 200、耗时与 JSON 高亮响应体 —— 完成!

桌面端(可选)

./run.sh gui

桌面端复用同一份界面与数据通道,HTTP 请求走 Tauri 原生网络栈,不依赖浏览器 CORS。

提示:首次打开会自动创建两个环境(正式 / 本地)和一个覆盖全部协议的示例集合,可随时在「设置」中重置。