文档去源码化：公开文档不再引导 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:
logan committed
1 parent
c0617ffdc8
commit
f6f61b35d8
12 files changed
+47
-124
No files matched your search
+19
-75
@@ -140,83 +140,27 @@
|
||||
<h1 class="page-title">快速开始</h1>
|
||||
<div class="page-meta">更新于 2026-09-17</div>
|
||||
<article class="md">
|
||||
<h2 id="sec-1">环境要求</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>组件</th>
|
||||
<th>版本</th>
|
||||
<th>用途</th>
|
||||
</tr>
|
||||
</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>
|
||||
<p>OpsxAPI 面向<strong>最终使用者</strong>交付：安装即用，无需搭建环境、无需接触源码。当前为 <strong>v0.1 公测</strong>阶段，安装包通过以下方式获取：</p>
|
||||
<ul>
|
||||
<li>官网 <a href="/#contact">获取安装包</a>（邮件说明平台：macOS Apple Silicon / Intel，Windows 规划中）；</li>
|
||||
<li>微信交流群（设置 → 关于 → 微信群，群公告提供最新公测包）。</li>
|
||||
</ul>
|
||||
<h2 id="sec-1">安装</h2>
|
||||
<p>macOS：下载 <code>.dmg</code>，拖入「应用程序」即完成；首次启动自动初始化本地数据与示例集合，无需任何配置。桌面版内置本地服务（Mock、代理隧道、回显服务），随应用自动运行。</p>
|
||||
<h2 id="sec-2">30 秒发出第一个请求</h2>
|
||||
<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>发送</strong>。</li>
|
||||
<li>下方响应区显示 <code>200</code>、耗时与 JSON 高亮响应体 —— 完成！</li>
|
||||
</ol>
|
||||
<h2 id="sec-4">桌面端（可选）</h2>
|
||||
<pre><code class="language-bash">./run.sh gui
|
||||
</code></pre>
|
||||
<p>桌面端复用同一份界面与数据通道，HTTP 请求走 Tauri 原生网络栈，不依赖浏览器 CORS。</p>
|
||||
<p>想验证更多能力？示例集合里的 <strong>Bearer 鉴权示例</strong>、<strong>GraphQL 国家查询</strong>、<strong>WebSocket echo</strong> 都指向公共演示服务，直接发送即可体验。</p>
|
||||
<h2 id="sec-3">切换环境</h2>
|
||||
<p>顶栏环境选择器可在「正式 / 本地」之间切换：<code>{{baseUrl}}</code> 等变量与前置 URL 随之生效。你可以把示例接口的域名改成自己的服务再发送。</p>
|
||||
<h2 id="sec-4">试用与授权</h2>
|
||||
<p>桌面版含 <strong>30 天全功能试用</strong>（首次启动自动开始，无需注册）。试用期结束后个人非商业用途可继续使用；商用授权与离线激活见<a href="/docs/license">授权说明</a>与<a href="/pricing">定价</a>。</p>
|
||||
<blockquote>
|
||||
<p><strong>提示</strong>：首次打开会自动创建两个环境（正式 / 本地）和一个覆盖全部协议的示例集合，可随时在「设置」中重置。</p>
|
||||
<p><strong>提示</strong>：首次打开会自动创建两个环境（正式 / 本地）和示例集合，可随时在「设置 → 数据管理」中重置工作区。</p>
|
||||
</blockquote>
|
||||
|
||||
</article>
|
||||
@@ -241,10 +185,10 @@ make install # 安装依赖（npm install，含桌面端）
|
||||
<aside class="toc">
|
||||
<div class="toc-title">本页目录</div>
|
||||
<nav class="toc-nav">
|
||||
<a class="toc-l2" href="#sec-1">环境要求</a>
|
||||
<a class="toc-l2" href="#sec-2">启动</a>
|
||||
<a class="toc-l2" href="#sec-3">30 秒发出第一个请求</a>
|
||||
<a class="toc-l2" href="#sec-4">桌面端（可选）</a>
|
||||
<a class="toc-l2" href="#sec-1">安装</a>
|
||||
<a class="toc-l2" href="#sec-2">30 秒发出第一个请求</a>
|
||||
<a class="toc-l2" href="#sec-3">切换环境</a>
|
||||
<a class="toc-l2" href="#sec-4">试用与授权</a>
|
||||
|
||||
</nav>
|
||||
<button class="print-btn" id="print-btn"><svg class="i"><use href="#i-printer"/></svg> 打印 / 导出 PDF</button>
|
||||
|
||||
Reference in new issue
Block a user