From f6f61b35d830d65a36958fb9b3c0c00ecb1a4037 Mon Sep 17 00:00:00 2001 From: logan Date: Fri, 16 Oct 2026 12:19:30 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=8E=BB=E6=BA=90=E7=A0=81?= =?UTF-8?q?=E5=8C=96=EF=BC=9A=E5=85=AC=E5=BC=80=E6=96=87=E6=A1=A3=E4=B8=8D?= =?UTF-8?q?=E5=86=8D=E5=BC=95=E5=AF=BC=20git=20clone=20/=20run.sh=EF=BC=88?= =?UTF-8?q?=E5=95=86=E4=B8=9A=E8=BD=AF=E4=BB=B6=E5=8F=A3=E5=BE=84=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 02-快速开始 整篇重写为最终用户视角：官网/微信群获取安装包 → 安装即用 → 30 秒首请求 → 切换环境 → 试用与授权指引；删除环境要求表/克隆启动/命令表 - 01-介绍「开箱即用」改为安装即用口径；08-WebSocket 隧道说明改为随应用自动运行； 19-FAQ CORS 排查项去掉 curl/run.sh；18-服务端部署建议改为私有化发行包交付 （单二进制+静态资源，不依赖源码与构建工具链） - 重建后 quickstart/落地页 git clone、run.sh、npm、cargo 残留均为 0；五页零断链 --- homepage/content/01-intro.md | 2 +- homepage/content/02-quickstart.md | 49 ++++-------- homepage/content/08-websocket.md | 2 +- homepage/content/18-server-api.md | 4 +- homepage/content/19-faq.md | 4 +- homepage/dist/docs/faq/index.html | 4 +- homepage/dist/docs/index.html | 2 +- homepage/dist/docs/intro/index.html | 2 +- homepage/dist/docs/quickstart/index.html | 94 +++++------------------- homepage/dist/docs/search-data.json | 2 +- homepage/dist/docs/server-api/index.html | 4 +- homepage/dist/docs/websocket/index.html | 2 +- 12 files changed, 47 insertions(+), 124 deletions(-) diff --git a/homepage/content/01-intro.md b/homepage/content/01-intro.md index 890eb40..7c4e8dd 100644 --- a/homepage/content/01-intro.md +++ b/homepage/content/01-intro.md @@ -29,7 +29,7 @@ OpsxAPI 是一款**本地优先**的专业接口工作台，面向运维与开 ## 为什么选 OpsxAPI - **数据主权**：所有集合、环境、历史保存在本机，不经过任何第三方服务器。 -- **开箱即用**：`./run.sh web` 一条命令启动；首次打开自带覆盖全部协议的示例集合。 +- **开箱即用**：安装即用、零配置；首次打开自带覆盖全部协议的示例集合。 - **工程友好**：导入自动建目录、路径参数自动转变量；导出即标准 OpenAPI，可回流 Apifox / Swagger 生态。 - **轻量克制**：一个 Go 二进制 + 一份前端，资源占用小，内网可部署。 diff --git a/homepage/content/02-quickstart.md b/homepage/content/02-quickstart.md index f9d36a3..26d4681 100644 --- a/homepage/content/02-quickstart.md +++ b/homepage/content/02-quickstart.md @@ -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. 打开 ，左侧是内置的「示例集合」。 +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)。 + +> **提示**：首次打开会自动创建两个环境（正式 / 本地）和示例集合，可随时在「设置 → 数据管理」中重置工作区。 diff --git a/homepage/content/08-websocket.md b/homepage/content/08-websocket.md index f2ff524..509faa9 100644 --- a/homepage/content/08-websocket.md +++ b/homepage/content/08-websocket.md @@ -26,7 +26,7 @@ graphql-transport-ws, v1.json - Gin → 目标服务器（携带你填的全部 Header） 2. 不填 Header 时直连目标，零额外开销。 -> **注意**：隧道要求本地 Gin 服务（:8787）在运行，即用 `./run.sh web` / `gui` 启动的默认形态。 +> **说明**：隧道由应用自带的本地服务提供 —— 桌面版随应用自动运行，无需任何手动配置。 ## 调试技巧 diff --git a/homepage/content/18-server-api.md b/homepage/content/18-server-api.md index d0767c7..b575d14 100644 --- a/homepage/content/18-server-api.md +++ b/homepage/content/18-server-api.md @@ -71,5 +71,5 @@ attach 后第一条消息为控制帧 `{"type":"open"}`；此后浏览器与目 ## 部署建议 -- 开发：`./run.sh web`（Vite :5173 反代 `/v1`、`/docs` 到 :8787）。 -- 生产：`npm run build:web` 产物交给任意静态服务器，`opsxapi-server` 独立部署；生产环境建议置于内网并按需增加鉴权反向代理。 +- 私有化交付随授权提供发行包（`opsxapi-server` 单二进制 + 官网静态资源），解压即用，不依赖源码与构建工具链； +- 生产环境建议置于内网，并按需增加鉴权反向代理；数据目录（SQLite）做好备份策略。 diff --git a/homepage/content/19-faq.md b/homepage/content/19-faq.md index fd9125c..8ed4d34 100644 --- a/homepage/content/19-faq.md +++ b/homepage/content/19-faq.md @@ -2,8 +2,8 @@ Web 端请求默认经本地 Gin 代理（gin-proxy）发出，不会遇到 CORS。若仍报错： -- 确认 Gin 在运行：`curl http://127.0.0.1:8787/health`。 -- 用 `./run.sh web` / `gui` 场景启动（Vite 已配置 `/v1` 反代）。 +- 重启应用后再试（本地服务随应用自动运行）。 +- 检查本机防火墙 / 安全软件是否拦截了应用的本地回环端口。 - 桌面端优先走 Tauri 原生网络栈，同样不受 CORS 限制。 ## 浏览器 WebSocket 不能加自定义 Header？ diff --git a/homepage/dist/docs/faq/index.html b/homepage/dist/docs/faq/index.html index fe8b91f..4b8d508 100644 --- a/homepage/dist/docs/faq/index.html +++ b/homepage/dist/docs/faq/index.html @@ -143,8 +143,8 @@

请求报 CORS 错误？

Web 端请求默认经本地 Gin 代理（gin-proxy）发出，不会遇到 CORS。若仍报错：

浏览器 WebSocket 不能加自定义 Header？

diff --git a/homepage/dist/docs/index.html b/homepage/dist/docs/index.html index 4ec678d..00d9fa7 100644 --- a/homepage/dist/docs/index.html +++ b/homepage/dist/docs/index.html @@ -230,7 +230,7 @@

为什么选 OpsxAPI

diff --git a/homepage/dist/docs/intro/index.html b/homepage/dist/docs/intro/index.html index 4ec678d..00d9fa7 100644 --- a/homepage/dist/docs/intro/index.html +++ b/homepage/dist/docs/intro/index.html @@ -230,7 +230,7 @@

为什么选 OpsxAPI

diff --git a/homepage/dist/docs/quickstart/index.html b/homepage/dist/docs/quickstart/index.html index 0578d9a..ef0a1b5 100644 --- a/homepage/dist/docs/quickstart/index.html +++ b/homepage/dist/docs/quickstart/index.html @@ -140,83 +140,27 @@

快速开始

更新于 2026-09-17
-

环境要求

- - - - - - - - - - - - - - - - - - - - - - - - - -
组件版本用途
Node.js≥ 20Web 前端（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 allWeb + 桌面一起开
./run.sh status / stop查看状态 / 停止
-

30 秒发出第一个请求

+

OpsxAPI 面向最终使用者交付：安装即用，无需搭建环境、无需接触源码。当前为 v0.1 公测阶段，安装包通过以下方式获取：

+
    +
  • 官网 获取安装包（邮件说明平台：macOS Apple Silicon / Intel，Windows 规划中）；
    • +
  • 微信交流群（设置 → 关于 → 微信群，群公告提供最新公测包）。
    • +
+

安装

+

macOS：下载 .dmg，拖入「应用程序」即完成；首次启动自动初始化本地数据与示例集合，无需任何配置。桌面版内置本地服务（Mock、代理隧道、回显服务），随应用自动运行。

+

30 秒发出第一个请求

    -
  1. 打开 http://127.0.0.1:5173，左侧是内置的「示例集合」。
    2. +
  2. 启动 OpsxAPI，左侧是内置的「示例集合」（覆盖六种协议）。
  3. 点击 HTTP · httpbin → 获取请求回显。
  4. 点击右上角 发送。
  5. 下方响应区显示 200、耗时与 JSON 高亮响应体 —— 完成！
-

桌面端（可选）

-
./run.sh gui
-
-

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

+

想验证更多能力？示例集合里的 Bearer 鉴权示例、GraphQL 国家查询、WebSocket echo 都指向公共演示服务，直接发送即可体验。

+

切换环境

+

顶栏环境选择器可在「正式 / 本地」之间切换：{{baseUrl}} 等变量与前置 URL 随之生效。你可以把示例接口的域名改成自己的服务再发送。

+

试用与授权

+

桌面版含 30 天全功能试用（首次启动自动开始，无需注册）。试用期结束后个人非商业用途可继续使用；商用授权与离线激活见授权说明与定价。

-

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

+

提示：首次打开会自动创建两个环境（正式 / 本地）和示例集合，可随时在「设置 → 数据管理」中重置工作区。

@@ -241,10 +185,10 @@ make install # 安装依赖（npm install，含桌面端）