文档去源码化:公开文档不再引导 git clone / run.sh(商业软件口径)
- 02-快速开始 整篇重写为最终用户视角:官网/微信群获取安装包 → 安装即用 → 30 秒首请求 → 切换环境 → 试用与授权指引;删除环境要求表/克隆启动/命令表 - 01-介绍「开箱即用」改为安装即用口径;08-WebSocket 隧道说明改为随应用自动运行; 19-FAQ CORS 排查项去掉 curl/run.sh;18-服务端部署建议改为私有化发行包交付 (单二进制+静态资源,不依赖源码与构建工具链) - 重建后 quickstart/落地页 git clone、run.sh、npm、cargo 残留均为 0;五页零断链
This commit is contained in:
1 parent
c0617ffdc8
commit
f6f61b35d8
12 files changed
+47
-124
No files matched your search
@@ -29,7 +29,7 @@ OpsxAPI 是一款**本地优先**的专业接口工作台,面向运维与开
|
|||||||
## 为什么选 OpsxAPI
|
## 为什么选 OpsxAPI
|
||||||
|
|
||||||
- **数据主权**:所有集合、环境、历史保存在本机,不经过任何第三方服务器。
|
- **数据主权**:所有集合、环境、历史保存在本机,不经过任何第三方服务器。
|
||||||
- **开箱即用**:`./run.sh web` 一条命令启动;首次打开自带覆盖全部协议的示例集合。
|
- **开箱即用**:安装即用、零配置;首次打开自带覆盖全部协议的示例集合。
|
||||||
- **工程友好**:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。
|
- **工程友好**:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。
|
||||||
- **轻量克制**:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。
|
- **轻量克制**:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。
|
||||||
|
|
||||||
|
|||||||
@@ -1,48 +1,27 @@
|
|||||||
## 环境要求
|
OpsxAPI 面向**最终使用者**交付:安装即用,无需搭建环境、无需接触源码。当前为 **v0.1 公测**阶段,安装包通过以下方式获取:
|
||||||
|
|
||||||
| 组件 | 版本 | 用途 |
|
- 官网 [获取安装包](/#contact)(邮件说明平台:macOS Apple Silicon / Intel,Windows 规划中);
|
||||||
| --- | --- | --- |
|
- 微信交流群(设置 → 关于 → 微信群,群公告提供最新公测包)。
|
||||||
| Node.js | ≥ 20 | Web 前端(Vite) |
|
|
||||||
| Go | ≥ 1.23 | 本地代理服务(Gin) |
|
|
||||||
| Rust + Cargo | 可选 | 仅编译桌面端(Tauri)时需要 |
|
|
||||||
|
|
||||||
## 启动
|
## 安装
|
||||||
|
|
||||||
```bash
|
macOS:下载 `.dmg`,拖入「应用程序」即完成;首次启动自动初始化本地数据与示例集合,无需任何配置。桌面版内置本地服务(Mock、代理隧道、回显服务),随应用自动运行。
|
||||||
git clone <你的仓库地址> opsxapi
|
|
||||||
cd opsxapi
|
|
||||||
make install # 安装依赖(npm install,含桌面端)
|
|
||||||
|
|
||||||
./run.sh web # 启动:Gin(:8787) + Web UI(:5173)
|
|
||||||
```
|
|
||||||
|
|
||||||
看到下面的输出即可打开浏览器:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
[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 秒发出第一个请求
|
## 30 秒发出第一个请求
|
||||||
|
|
||||||
1. 打开 <http://127.0.0.1:5173>,左侧是内置的「示例集合」。
|
1. 启动 OpsxAPI,左侧是内置的「示例集合」(覆盖六种协议)。
|
||||||
2. 点击 **HTTP · httpbin → 获取请求回显**。
|
2. 点击 **HTTP · httpbin → 获取请求回显**。
|
||||||
3. 点击右上角 **发送**。
|
3. 点击右上角 **发送**。
|
||||||
4. 下方响应区显示 `200`、耗时与 JSON 高亮响应体 —— 完成!
|
4. 下方响应区显示 `200`、耗时与 JSON 高亮响应体 —— 完成!
|
||||||
|
|
||||||
## 桌面端(可选)
|
想验证更多能力?示例集合里的 **Bearer 鉴权示例**、**GraphQL 国家查询**、**WebSocket echo** 都指向公共演示服务,直接发送即可体验。
|
||||||
|
|
||||||
```bash
|
## 切换环境
|
||||||
./run.sh gui
|
|
||||||
```
|
|
||||||
|
|
||||||
桌面端复用同一份界面与数据通道,HTTP 请求走 Tauri 原生网络栈,不依赖浏览器 CORS。
|
顶栏环境选择器可在「正式 / 本地」之间切换:`{{baseUrl}}` 等变量与前置 URL 随之生效。你可以把示例接口的域名改成自己的服务再发送。
|
||||||
|
|
||||||
> **提示**:首次打开会自动创建两个环境(正式 / 本地)和一个覆盖全部协议的示例集合,可随时在「设置」中重置。
|
## 试用与授权
|
||||||
|
|
||||||
|
桌面版含 **30 天全功能试用**(首次启动自动开始,无需注册)。试用期结束后个人非商业用途可继续使用;商用授权与离线激活见[授权说明](/docs/license)与[定价](/pricing)。
|
||||||
|
|
||||||
|
> **提示**:首次打开会自动创建两个环境(正式 / 本地)和示例集合,可随时在「设置 → 数据管理」中重置工作区。
|
||||||
@@ -26,7 +26,7 @@ graphql-transport-ws, v1.json
|
|||||||
- Gin → 目标服务器(携带你填的全部 Header)
|
- Gin → 目标服务器(携带你填的全部 Header)
|
||||||
2. 不填 Header 时直连目标,零额外开销。
|
2. 不填 Header 时直连目标,零额外开销。
|
||||||
|
|
||||||
> **注意**:隧道要求本地 Gin 服务(:8787)在运行,即用 `./run.sh web` / `gui` 启动的默认形态。
|
> **说明**:隧道由应用自带的本地服务提供 —— 桌面版随应用自动运行,无需任何手动配置。
|
||||||
|
|
||||||
## 调试技巧
|
## 调试技巧
|
||||||
|
|
||||||
|
|||||||
@@ -71,5 +71,5 @@ attach 后第一条消息为控制帧 `{"type":"open"}`;此后浏览器与目
|
|||||||
|
|
||||||
## 部署建议
|
## 部署建议
|
||||||
|
|
||||||
- 开发:`./run.sh web`(Vite :5173 反代 `/v1`、`/docs` 到 :8787)。
|
- 私有化交付随授权提供发行包(`opsxapi-server` 单二进制 + 官网静态资源),解压即用,不依赖源码与构建工具链;
|
||||||
- 生产:`npm run build:web` 产物交给任意静态服务器,`opsxapi-server` 独立部署;生产环境建议置于内网并按需增加鉴权反向代理。
|
- 生产环境建议置于内网,并按需增加鉴权反向代理;数据目录(SQLite)做好备份策略。
|
||||||
@@ -2,8 +2,8 @@
|
|||||||
|
|
||||||
Web 端请求默认经本地 Gin 代理(gin-proxy)发出,不会遇到 CORS。若仍报错:
|
Web 端请求默认经本地 Gin 代理(gin-proxy)发出,不会遇到 CORS。若仍报错:
|
||||||
|
|
||||||
- 确认 Gin 在运行:`curl http://127.0.0.1:8787/health`。
|
- 重启应用后再试(本地服务随应用自动运行)。
|
||||||
- 用 `./run.sh web` / `gui` 场景启动(Vite 已配置 `/v1` 反代)。
|
- 检查本机防火墙 / 安全软件是否拦截了应用的本地回环端口。
|
||||||
- 桌面端优先走 Tauri 原生网络栈,同样不受 CORS 限制。
|
- 桌面端优先走 Tauri 原生网络栈,同样不受 CORS 限制。
|
||||||
|
|
||||||
## 浏览器 WebSocket 不能加自定义 Header?
|
## 浏览器 WebSocket 不能加自定义 Header?
|
||||||
|
|||||||
Vendored
+2
-2
@@ -143,8 +143,8 @@
|
|||||||
<h2 id="sec-1">请求报 CORS 错误?</h2>
|
<h2 id="sec-1">请求报 CORS 错误?</h2>
|
||||||
<p>Web 端请求默认经本地 Gin 代理(gin-proxy)发出,不会遇到 CORS。若仍报错:</p>
|
<p>Web 端请求默认经本地 Gin 代理(gin-proxy)发出,不会遇到 CORS。若仍报错:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>确认 Gin 在运行:<code>curl http://127.0.0.1:8787/health</code>。</li>
|
<li>重启应用后再试(本地服务随应用自动运行)。</li>
|
||||||
<li>用 <code>./run.sh web</code> / <code>gui</code> 场景启动(Vite 已配置 <code>/v1</code> 反代)。</li>
|
<li>检查本机防火墙 / 安全软件是否拦截了应用的本地回环端口。</li>
|
||||||
<li>桌面端优先走 Tauri 原生网络栈,同样不受 CORS 限制。</li>
|
<li>桌面端优先走 Tauri 原生网络栈,同样不受 CORS 限制。</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="sec-2">浏览器 WebSocket 不能加自定义 Header?</h2>
|
<h2 id="sec-2">浏览器 WebSocket 不能加自定义 Header?</h2>
|
||||||
|
|||||||
Vendored
+1
-1
@@ -230,7 +230,7 @@
|
|||||||
<h2 id="sec-3">为什么选 OpsxAPI</h2>
|
<h2 id="sec-3">为什么选 OpsxAPI</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><strong>数据主权</strong>:所有集合、环境、历史保存在本机,不经过任何第三方服务器。</li>
|
<li><strong>数据主权</strong>:所有集合、环境、历史保存在本机,不经过任何第三方服务器。</li>
|
||||||
<li><strong>开箱即用</strong>:<code>./run.sh web</code> 一条命令启动;首次打开自带覆盖全部协议的示例集合。</li>
|
<li><strong>开箱即用</strong>:安装即用、零配置;首次打开自带覆盖全部协议的示例集合。</li>
|
||||||
<li><strong>工程友好</strong>:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。</li>
|
<li><strong>工程友好</strong>:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。</li>
|
||||||
<li><strong>轻量克制</strong>:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。</li>
|
<li><strong>轻量克制</strong>:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|||||||
Vendored
+1
-1
@@ -230,7 +230,7 @@
|
|||||||
<h2 id="sec-3">为什么选 OpsxAPI</h2>
|
<h2 id="sec-3">为什么选 OpsxAPI</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><strong>数据主权</strong>:所有集合、环境、历史保存在本机,不经过任何第三方服务器。</li>
|
<li><strong>数据主权</strong>:所有集合、环境、历史保存在本机,不经过任何第三方服务器。</li>
|
||||||
<li><strong>开箱即用</strong>:<code>./run.sh web</code> 一条命令启动;首次打开自带覆盖全部协议的示例集合。</li>
|
<li><strong>开箱即用</strong>:安装即用、零配置;首次打开自带覆盖全部协议的示例集合。</li>
|
||||||
<li><strong>工程友好</strong>:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。</li>
|
<li><strong>工程友好</strong>:导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。</li>
|
||||||
<li><strong>轻量克制</strong>:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。</li>
|
<li><strong>轻量克制</strong>:一个 Go 二进制 + 一份前端,资源占用小,内网可部署。</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|||||||
+19
-75
@@ -140,83 +140,27 @@
|
|||||||
<h1 class="page-title">快速开始</h1>
|
<h1 class="page-title">快速开始</h1>
|
||||||
<div class="page-meta">更新于 2026-09-17</div>
|
<div class="page-meta">更新于 2026-09-17</div>
|
||||||
<article class="md">
|
<article class="md">
|
||||||
<h2 id="sec-1">环境要求</h2>
|
<p>OpsxAPI 面向<strong>最终使用者</strong>交付:安装即用,无需搭建环境、无需接触源码。当前为 <strong>v0.1 公测</strong>阶段,安装包通过以下方式获取:</p>
|
||||||
<table>
|
<ul>
|
||||||
<thead>
|
<li>官网 <a href="/#contact">获取安装包</a>(邮件说明平台:macOS Apple Silicon / Intel,Windows 规划中);</li>
|
||||||
<tr>
|
<li>微信交流群(设置 → 关于 → 微信群,群公告提供最新公测包)。</li>
|
||||||
<th>组件</th>
|
</ul>
|
||||||
<th>版本</th>
|
<h2 id="sec-1">安装</h2>
|
||||||
<th>用途</th>
|
<p>macOS:下载 <code>.dmg</code>,拖入「应用程序」即完成;首次启动自动初始化本地数据与示例集合,无需任何配置。桌面版内置本地服务(Mock、代理隧道、回显服务),随应用自动运行。</p>
|
||||||
</tr>
|
<h2 id="sec-2">30 秒发出第一个请求</h2>
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td>Node.js</td>
|
|
||||||
<td>≥ 20</td>
|
|
||||||
<td>Web 前端(Vite)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Go</td>
|
|
||||||
<td>≥ 1.23</td>
|
|
||||||
<td>本地代理服务(Gin)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Rust + Cargo</td>
|
|
||||||
<td>可选</td>
|
|
||||||
<td>仅编译桌面端(Tauri)时需要</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h2 id="sec-2">启动</h2>
|
|
||||||
<pre><code class="language-bash">git clone <你的仓库地址> opsxapi
|
|
||||||
cd opsxapi
|
|
||||||
make install # 安装依赖(npm install,含桌面端)
|
|
||||||
|
|
||||||
./run.sh web # 启动:Gin(:8787) + Web UI(:5173)
|
|
||||||
</code></pre>
|
|
||||||
<p>看到下面的输出即可打开浏览器:</p>
|
|
||||||
<pre><code class="language-bash">[OK] 后端 UP http://127.0.0.1:8787/health
|
|
||||||
[OK] Web UP http://127.0.0.1:5173
|
|
||||||
</code></pre>
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>命令</th>
|
|
||||||
<th>说明</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td><code>./run.sh web</code></td>
|
|
||||||
<td>浏览器版(推荐)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>./run.sh gui</code></td>
|
|
||||||
<td>桌面窗口(Tauri,共用同一 UI)</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>./run.sh all</code></td>
|
|
||||||
<td>Web + 桌面一起开</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>./run.sh status</code> / <code>stop</code></td>
|
|
||||||
<td>查看状态 / 停止</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h2 id="sec-3">30 秒发出第一个请求</h2>
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>打开 <a href="http://127.0.0.1:5173">http://127.0.0.1:5173</a>,左侧是内置的「示例集合」。</li>
|
<li>启动 OpsxAPI,左侧是内置的「示例集合」(覆盖六种协议)。</li>
|
||||||
<li>点击 <strong>HTTP · httpbin → 获取请求回显</strong>。</li>
|
<li>点击 <strong>HTTP · httpbin → 获取请求回显</strong>。</li>
|
||||||
<li>点击右上角 <strong>发送</strong>。</li>
|
<li>点击右上角 <strong>发送</strong>。</li>
|
||||||
<li>下方响应区显示 <code>200</code>、耗时与 JSON 高亮响应体 —— 完成!</li>
|
<li>下方响应区显示 <code>200</code>、耗时与 JSON 高亮响应体 —— 完成!</li>
|
||||||
</ol>
|
</ol>
|
||||||
<h2 id="sec-4">桌面端(可选)</h2>
|
<p>想验证更多能力?示例集合里的 <strong>Bearer 鉴权示例</strong>、<strong>GraphQL 国家查询</strong>、<strong>WebSocket echo</strong> 都指向公共演示服务,直接发送即可体验。</p>
|
||||||
<pre><code class="language-bash">./run.sh gui
|
<h2 id="sec-3">切换环境</h2>
|
||||||
</code></pre>
|
<p>顶栏环境选择器可在「正式 / 本地」之间切换:<code>{{baseUrl}}</code> 等变量与前置 URL 随之生效。你可以把示例接口的域名改成自己的服务再发送。</p>
|
||||||
<p>桌面端复用同一份界面与数据通道,HTTP 请求走 Tauri 原生网络栈,不依赖浏览器 CORS。</p>
|
<h2 id="sec-4">试用与授权</h2>
|
||||||
|
<p>桌面版含 <strong>30 天全功能试用</strong>(首次启动自动开始,无需注册)。试用期结束后个人非商业用途可继续使用;商用授权与离线激活见<a href="/docs/license">授权说明</a>与<a href="/pricing">定价</a>。</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p><strong>提示</strong>:首次打开会自动创建两个环境(正式 / 本地)和一个覆盖全部协议的示例集合,可随时在「设置」中重置。</p>
|
<p><strong>提示</strong>:首次打开会自动创建两个环境(正式 / 本地)和示例集合,可随时在「设置 → 数据管理」中重置工作区。</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
@@ -241,10 +185,10 @@ make install # 安装依赖(npm install,含桌面端)
|
|||||||
<aside class="toc">
|
<aside class="toc">
|
||||||
<div class="toc-title">本页目录</div>
|
<div class="toc-title">本页目录</div>
|
||||||
<nav class="toc-nav">
|
<nav class="toc-nav">
|
||||||
<a class="toc-l2" href="#sec-1">环境要求</a>
|
<a class="toc-l2" href="#sec-1">安装</a>
|
||||||
<a class="toc-l2" href="#sec-2">启动</a>
|
<a class="toc-l2" href="#sec-2">30 秒发出第一个请求</a>
|
||||||
<a class="toc-l2" href="#sec-3">30 秒发出第一个请求</a>
|
<a class="toc-l2" href="#sec-3">切换环境</a>
|
||||||
<a class="toc-l2" href="#sec-4">桌面端(可选)</a>
|
<a class="toc-l2" href="#sec-4">试用与授权</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
<button class="print-btn" id="print-btn"><svg class="i"><use href="#i-printer"/></svg> 打印 / 导出 PDF</button>
|
<button class="print-btn" id="print-btn"><svg class="i"><use href="#i-printer"/></svg> 打印 / 导出 PDF</button>
|
||||||
|
|||||||
Vendored
+1
-1
@@ -1 +1 @@
|
|||||||
[{"Slug":"intro","Title":"产品介绍","Group":"开始使用","Text":"OpsxAPI 是一款 本地优先 的专业接口工作台,面向运维与开发,把 HTTP、GraphQL、WebSocket、SSE、Socket.IO、MQTT 六种协议的调试放进同一个窗口。 无需注册、无需联网同步,数据全部保存在本地浏览器(localStorage),导出备份随时带走。 功能总览 能力 说明 六种协议 HTTP / GraphQL / WebSocket / SSE / Socket.IO / MQTT 集合管理 目录树、搜索、右键菜单、拖拽移动、多标签页 多环境变量 、 全局替换,一键切换环境 数据导入 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 数据主权 :所有集合、环境、历史保存在本机,不经过任何第三方服务器。 开箱即用 : 一条命令启动;首次打开自带覆盖全部协议的示例集合。 工程友好 :导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。 轻量克制 :一个 Go 二进制 + 一份前端,资源占用小,内网可部署。 提示 :想快速感受?直接看下一章《快速开始》,30 秒发出第一个请求。"},{"Slug":"quickstart","Title":"快速开始","Group":"开始使用","Text":"环境要求 组件 版本 用途 Node.js ≥ 20 Web 前端(Vite) Go ≥ 1.23 本地代理服务(Gin) Rust + Cargo 可选 仅编译桌面端(Tauri)时需要 启动 看到下面的输出即可打开浏览器: 命令 说明 浏览器版(推荐) 桌面窗口(Tauri,共用同一 UI) Web + 桌面一起开 / 查看状态 / 停止 30 秒发出第一个请求 1. 打开 \u003chttp://127.0.0.1:5173 ,左侧是内置的「示例集合」。 2. 点击 HTTP · httpbin → 获取请求回显 。 3. 点击右上角 发送 。 4. 下方响应区显示 、耗时与 JSON 高亮响应体 —— 完成! 桌面端(可选) 桌面端复用同一份界面与数据通道,HTTP 请求走 Tauri 原生网络栈,不依赖浏览器 CORS。 提示 :首次打开会自动创建两个环境(正式 / 本地)和一个覆盖全部协议的示例集合,可随时在「设置」中重置。"},{"Slug":"interface","Title":"界面导览","Group":"开始使用","Text":"OpsxAPI 主界面由「活动栏 + 顶栏 + 侧栏 + 标签页 + 编辑区」组成: 活动栏(最左窄栏) 元素 作用 空间徽标(顶部) 切换 本地空间 / 我的空间 / 团队空间;云端空间显示同步状态点 接口 / 历史 / 测试 / 文档 / Mock 主导航:接口工作台、请求历史、自动化测试、接口文档、Mock 管理 授权徽章 试用倒计时或已授权状态,点击进入 设置 → 授权 设置 / 账号 设置中心;账号菜单(团队管理、立即同步、退出登录) 顶栏 元素 作用 + 新建 六种协议请求 / 目录(默认建在第一个集合) 导入 / 导出 数据导入(十种格式)与导出对话框 环境选择器 切换当前环境(变量与前置 URL 随之生效),可直达环境管理 左侧栏(接口 历史 分段) 接口 :集合树 — 点击请求在标签页打开,目录展开 / 折叠; 右键 新建 / 重命名 / 复制 / 导出 / 删除; 拖拽 移动(支持跨集合);顶部搜索实时过滤。 历史 :最近请求自动归档(状态码 / 耗时),点击回跳对应接口,支持一键清空。 标签页栏 同时打开多个接口,中键或 × 关闭;右键支持「关闭其他 / 关闭全部」。正在连接中的实时协议标签会显示呼吸圆点。 请求编辑区(上半部分) 按协议呈现不同编辑器: 协议 标签页 HTTP Params · Body · Headers · Cookies · Auth · 说明 GraphQL Query · Variables · Headers · Auth WebSocket 消息 · 握手配置 · 说明 SSE 事件流 · 连接配置 · 说明 Socket.IO 事件 · 连接配置 · 说明 MQTT 消息 · Broker / 订阅 · 发布 · 说明 响应区(下半部分) HTTP / GraphQL :响应体(Pretty JSON 高亮)、Raw、响应头,右上角状态 / 耗时 / 大小 / 复制。 实时协议 :分色消息日志(接Line truncated
|
[{"Slug":"intro","Title":"产品介绍","Group":"开始使用","Text":"OpsxAPI 是一款 本地优先 的专业接口工作台,面向运维与开发,把 HTTP、GraphQL、WebSocket、SSE、Socket.IO、MQTT 六种协议的调试放进同一个窗口。 无需注册、无需联网同步,数据全部保存在本地浏览器(localStorage),导出备份随时带走。 功能总览 能力 说明 六种协议 HTTP / GraphQL / WebSocket / SSE / Socket.IO / MQTT 集合管理 目录树、搜索、右键菜单、拖拽移动、多标签页 多环境变量 、 全局替换,一键切换环境 数据导入 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 数据主权 :所有集合、环境、历史保存在本机,不经过任何第三方服务器。 开箱即用 :安装即用、零配置;首次打开自带覆盖全部协议的示例集合。 工程友好 :导入自动建目录、路径参数自动转变量;导出即标准 OpenAPI,可回流 Apifox / Swagger 生态。 轻量克制 :一个 Go 二进制 + 一份前端,资源占用小,内网可部署。 提示 :想快速感受?直接看下一章《快速开始》,30 秒发出第一个请求。"},{"Slug":"quickstart","Title":"快速开始","Group":"开始使用","Text":"OpsxAPI 面向 最终使用者 交付:安装即用,无需搭建环境、无需接触源码。当前为 v0.1 公测 阶段,安装包通过以下方式获取: 官网 (邮件说明平台:macOS Apple Silicon / Intel,Windows 规划中); 微信交流群(设置 → 关于 → 微信群,群公告提供最新公测包)。 安装 macOS:下载 ,拖入「应用程序」即完成;首次启动自动初始化本地数据与示例集合,无需任何配置。桌面版内置本地服务(Mock、代理隧道、回显服务),随应用自动运行。 30 秒发出第一个请求 1. 启动 OpsxAPI,左侧是内置的「示例集合」(覆盖六种协议)。 2. 点击 HTTP · httpbin → 获取请求回显 。 3. 点击右上角 发送 。 4. 下方响应区显示 、耗时与 JSON 高亮响应体 —— 完成! 想验证更多能力?示例集合里的 Bearer 鉴权示例 、 GraphQL 国家查询 、 WebSocket echo 都指向公共演示服务,直接发送即可体验。 切换环境 顶栏环境选择器可在「正式 / 本地」之间切换: 等变量与前置 URL 随之生效。你可以把示例接口的域名改成自己的服务再发送。 试用与授权 桌面版含 30 天全功能试用 (首次启动自动开始,无需注册)。试用期结束后个人非商业用途可继续使用;商用授权与离线激活见 与 。 提示 :首次打开会自动创建两个环境(正式 / 本地)和示例集合,可随时在「设置 → 数据管理」中重置工作区。"},{"Slug":"interface","Title":"界面导览","Group":"开始使用","Text":"OpsxAPI 主界面由「活动栏 + 顶栏 + 侧栏 + 标签页 + 编辑区」组成: 活动栏(最左窄栏) 元素 作用 空间徽标(顶部) 切换 本地空间 / 我的空间 / 团队空间;云端空间显示同步状态点 接口 / 历史 / 测试 / 文档 / Mock 主导航:接口工作台、请求历史、自动化测试、接口文档、Mock 管理 授权徽章 试用倒计时或已授权状态,点击进入 设置 → 授权 设置 / 账号 设置中心;账号菜单(团队管理、立即同步、退出登录) 顶栏 元素 作用 + 新建 六种协议请求 / 目录(默认建在第一个集合) 导入 / 导出 数据导入(十种格式)与导出对话框 环境选择器 切换当前环境(变量与前置 URL 随之生效),可直达环境管理 左侧栏(接口 历史 分段) 接口 :集合树 — 点击请求在标签页打开,目录展开 / 折叠; 右键 新建 / 重命名 / 复制 / 导出 / 删除; 拖拽 移动(支持跨集合);顶部搜索实时过滤。 历史 :最近请求自动归档(状态码 / 耗时),点击回跳对应接口,支持一键清空。 标签页栏 同时打开多个接口,中键或 × 关闭;右键支持「关闭其他Line truncated
|
||||||
+2
-2
@@ -232,8 +232,8 @@ curl -s -X POST http://127.0.0.1:8787/v1/proxy/ws/close \
|
|||||||
</ul>
|
</ul>
|
||||||
<h2 id="sec-6">部署建议</h2>
|
<h2 id="sec-6">部署建议</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>开发:<code>./run.sh web</code>(Vite :5173 反代 <code>/v1</code>、<code>/docs</code> 到 :8787)。</li>
|
<li>私有化交付随授权提供发行包(<code>opsxapi-server</code> 单二进制 + 官网静态资源),解压即用,不依赖源码与构建工具链;</li>
|
||||||
<li>生产:<code>npm run build:web</code> 产物交给任意静态服务器,<code>opsxapi-server</code> 独立部署;生产环境建议置于内网并按需增加鉴权反向代理。</li>
|
<li>生产环境建议置于内网,并按需增加鉴权反向代理;数据目录(SQLite)做好备份策略。</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|||||||
+1
-1
@@ -167,7 +167,7 @@
|
|||||||
<li>不填 Header 时直连目标,零额外开销。</li>
|
<li>不填 Header 时直连目标,零额外开销。</li>
|
||||||
</ol>
|
</ol>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p><strong>注意</strong>:隧道要求本地 Gin 服务(:8787)在运行,即用 <code>./run.sh web</code> / <code>gui</code> 启动的默认形态。</p>
|
<p><strong>说明</strong>:隧道由应用自带的本地服务提供 —— 桌面版随应用自动运行,无需任何手动配置。</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<h2 id="sec-5">调试技巧</h2>
|
<h2 id="sec-5">调试技巧</h2>
|
||||||
<ul>
|
<ul>
|
||||||
|
|||||||
Reference in new issue
Block a user