文档站面向用户清理:删摆设组件 + 去实现名词 + 标题去重

- 删「打印/导出 PDF」按钮与「是否有帮助」反馈组件(静态站无后端,纯摆设)及未使用 SVG 图标
- 文档去 Tauri/Gin 等实现层名词(本地代理/隧道等用户语义保留)
- 5 页 markdown 首行 H1 与页面标题去重
- homepage dist 同步重建
This commit is contained in:
logan committed 2026-10-16 13:20:46 +08:00
1 parent 946983d599
commit ec9a7b8695
39 files changed
+53 -811

No files matched your search

+2 -2
View File
@@ -12,8 +12,8 @@ OpsxAPI 是一款**本地优先**的专业接口工作台,面向运维与开
| 数据导入 | 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)共用同一套界面 |
| 代理能力 | 本地代理绕开 CORS;WebSocket 隧道支持自定义握手 Header |
| 双端形态 | 浏览器(Web)与桌面端共用同一套界面 |
## 支持的协议与场景
+1 -1
View File
@@ -4,7 +4,7 @@
2. 输入 URL,支持 `{{baseUrl}}/path` 形式的变量(见《环境与变量》)。
3. 点击 **发送**,或直接在 URL 输入框按 **Enter**。
请求默认经本地 Gin 代理(`/v1/proxy/http`)发出,天然绕开浏览器 CORS 限制。
请求默认经本地代理(`/v1/proxy/http`)发出,天然绕开浏览器 CORS 限制。
## Params(查询参数)
+3 -3
View File
@@ -21,9 +21,9 @@ graphql-transport-ws, v1.json
浏览器原生 WebSocket **不能**携带自定义 Header(如 `Authorization`、`X-API-Key`)。OpsxAPI 的处理方式:
1. 「握手配置」中填写 Header 后,工具自动改走**本地 Gin 隧道**:
- 浏览器 → Gin `/v1/proxy/ws/attach`(普通 WS)
- Gin → 目标服务器(携带你填的全部 Header)
1. 「握手配置」中填写 Header 后,工具自动改走**本地隧道**:
- 浏览器 → 本地代理 `/v1/proxy/ws/attach`(普通 WS)
- 代理 → 目标服务器(携带你填的全部 Header)
2. 不填 Header 时直连目标,零额外开销。
> **说明**:隧道由应用自带的本地服务提供 —— 桌面版随应用自动运行,无需任何手动配置。
+1 -1
View File
@@ -7,7 +7,7 @@
## 直连与代理自动切换
- 默认**直连**目标站(fetch 流式读取,延迟最低)。
- 直连因 CORS / 网络失败时,自动降级走**本地 Gin 流式代理**,日志中会提示切换过程,无需手工干预。
- 直连因 CORS / 网络失败时,自动降级走**本地流式代理**,日志中会提示切换过程,无需手工干预。
## 断点续传(Last-Event-ID)
+1 -1
View File
@@ -4,7 +4,7 @@
| --- | --- |
| 粘贴文本 / cURL | 直接粘贴任意受支持格式的内容 |
| 文件导入 | 选择或拖入 `.json` / `.yaml` / `.har` / `.md` / `.txt` |
| URL 导入(Swagger) | 填写 OpenAPI 地址,经本地 Gin 代理拉取,避开 CORS |
| URL 导入(Swagger) | 填写 OpenAPI 地址,经本地代理拉取,避开 CORS |
格式**自动识别**,也可手动指定。
-2
View File
@@ -1,5 +1,3 @@
# Mock 数据
联调时后端接口没就绪?OpsxAPI 内置 **Mock.js 风格的数据生成器**,两种用法覆盖绝大多数场景:
1. **显式表达式** —— 在参数值、Body 中直接写 `@cname`、`@integer(1,100)`;
-2
View File
@@ -1,5 +1,3 @@
# 自动化测试
把日常联调的接口串成**场景用例**,一条龙验证业务流程。三种触发方式共用同一套用例模型:
| 方式 | 说明 | 适合 |
-2
View File
@@ -1,5 +1,3 @@
# AI 助手
接入 **OpenAI 兼容协议**的大模型,为自动化测试提供 AI 能力。模型调用直连供应商;供应商配置(包括密钥)随当前工作区保存,团队工作区会同步工作区数据。
## 配置模型供应商
+1 -1
View File
@@ -1,4 +1,4 @@
本地服务(Gin)默认监听 `:8787`,可用环境变量 `OPSXAPI_ADDR` 修改。所有端点仅监听本机回环,供 Web UI 与桌面端调用。
本地服务默认监听 `:8787`,可用环境变量 `OPSXAPI_ADDR` 修改。所有端点仅监听本机回环,供 Web UI 与桌面端调用。
## 端点总览
+4 -4
View File
@@ -1,14 +1,14 @@
## 请求报 CORS 错误?
Web 端请求默认经本地 Gin 代理(gin-proxy)发出,不会遇到 CORS。若仍报错:
Web 端请求默认经本地代理发出,不会遇到 CORS。若仍报错:
- 重启应用后再试(本地服务随应用自动运行)。
- 检查本机防火墙 / 安全软件是否拦截了应用的本地回环端口。
- 桌面端优先走 Tauri 原生网络栈,同样不受 CORS 限制。
- 桌面端走应用原生网络,同样不受 CORS 限制。
## 浏览器 WebSocket 不能加自定义 Header?
规范限制。在 WS「握手配置」里填写 Header 后,OpsxAPI 自动改走本地 Gin 隧道(见《WebSocket》章节),Header 由 Gin 在握手时代为携带。不填 Header 则直连。
规范限制。在 WS「握手配置」里填写 Header 后,OpsxAPI 自动改走本地隧道(见《WebSocket》章节),Header 由本地代理在握手时代为携带。不填 Header 则直连。
## 外部 wss:// 地址连不上(DNS 失败)?
@@ -29,7 +29,7 @@ Web 端请求默认经本地 Gin 代理(gin-proxy)发出,不会遇到 CORS
## SSE 事件流看着卡住了?
- 事件频率低(如告警流)属正常,等待即可。
- 部分网关会缓冲 SSE,工具会在直连失败时自动切换 Gin 流式代理;若仍无事件,检查中间层(Nginx 需关闭 `proxy_buffering`)。
- 部分网关会缓冲 SSE,工具会在直连失败时自动切换本地流式代理;若仍无事件,检查中间层(Nginx 需关闭 `proxy_buffering`)。
## 发送按钮点击后没反应?
-2
View File
@@ -1,5 +1,3 @@
# 账号与团队
登录后可使用**云端空间**:个人空间「我的空间」与团队共享空间,数据保存在本机服务的 SQLite 数据库(`server/data/opsxapi.db`),不上传任何第三方。
## 注册 / 登录
-2
View File
@@ -1,5 +1,3 @@
# 授权与激活
OpsxAPI 桌面版采用「**先试用、后授权**」模式:**30 天全功能试用**从应用首次启动自动开始,无需注册账号、无需信用卡。试用期结束后,个人非商业用途可继续使用;在工作中商用需购买授权([查看定价](/pricing))。
## 两种授权码