文档去源码化:公开文档不再引导 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
@@ -1,48 +1,27 @@
|
||||
## 环境要求
|
||||
OpsxAPI 面向**最终使用者**交付:安装即用,无需搭建环境、无需接触源码。当前为 **v0.1 公测**阶段,安装包通过以下方式获取:
|
||||
|
||||
| 组件 | 版本 | 用途 |
|
||||
| --- | --- | --- |
|
||||
| Node.js | ≥ 20 | Web 前端(Vite) |
|
||||
| Go | ≥ 1.23 | 本地代理服务(Gin) |
|
||||
| Rust + Cargo | 可选 | 仅编译桌面端(Tauri)时需要 |
|
||||
- 官网 [获取安装包](/#contact)(邮件说明平台:macOS Apple Silicon / Intel,Windows 规划中);
|
||||
- 微信交流群(设置 → 关于 → 微信群,群公告提供最新公测包)。
|
||||
|
||||
## 启动
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
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` | 查看状态 / 停止 |
|
||||
macOS:下载 `.dmg`,拖入「应用程序」即完成;首次启动自动初始化本地数据与示例集合,无需任何配置。桌面版内置本地服务(Mock、代理隧道、回显服务),随应用自动运行。
|
||||
|
||||
## 30 秒发出第一个请求
|
||||
|
||||
1. 打开 <http://127.0.0.1:5173>,左侧是内置的「示例集合」。
|
||||
1. 启动 OpsxAPI,左侧是内置的「示例集合」(覆盖六种协议)。
|
||||
2. 点击 **HTTP · httpbin → 获取请求回显**。
|
||||
3. 点击右上角 **发送**。
|
||||
4. 下方响应区显示 `200`、耗时与 JSON 高亮响应体 —— 完成!
|
||||
|
||||
## 桌面端(可选)
|
||||
想验证更多能力?示例集合里的 **Bearer 鉴权示例**、**GraphQL 国家查询**、**WebSocket echo** 都指向公共演示服务,直接发送即可体验。
|
||||
|
||||
```bash
|
||||
./run.sh gui
|
||||
```
|
||||
## 切换环境
|
||||
|
||||
桌面端复用同一份界面与数据通道,HTTP 请求走 Tauri 原生网络栈,不依赖浏览器 CORS。
|
||||
顶栏环境选择器可在「正式 / 本地」之间切换:`{{baseUrl}}` 等变量与前置 URL 随之生效。你可以把示例接口的域名改成自己的服务再发送。
|
||||
|
||||
> **提示**:首次打开会自动创建两个环境(正式 / 本地)和一个覆盖全部协议的示例集合,可随时在「设置」中重置。
|
||||
## 试用与授权
|
||||
|
||||
桌面版含 **30 天全功能试用**(首次启动自动开始,无需注册)。试用期结束后个人非商业用途可继续使用;商用授权与离线激活见[授权说明](/docs/license)与[定价](/pricing)。
|
||||
|
||||
> **提示**:首次打开会自动创建两个环境(正式 / 本地)和示例集合,可随时在「设置 → 数据管理」中重置工作区。
|
||||
Reference in new issue
Block a user