官网内容质量升级：基于代码真实功能重写卖点与文档
先做全量功能盘点（编辑器/测试/Mock/AI/导入导出/服务端/桌面授权），再对齐内容： - 落地页：hero 副标与药丸补 AI 用例/Cron 定时/智能 Mock；「为什么选」4→8 卡 （新增 自动化测试闭环/AI 生成用例/智能 Mock 双引擎/内网文档分享）；功能区 6→12 卡 （新增 测试/AI/智能 Mock/历史重放/系统代理/文档快照）；对比表 +3 行（断言/AI/Cron）； 定价卡对齐 3/5 台与真实权益；新增 bot/list-checks/flask/clock 图标 - 文档：03-界面导览 重写为活动栏时代（含授权徽章/空间切换）；16-测试 补 5 段 Cron 章节（示例/15s 巡检/30 条日志/防重入）与 JSON 报告格式；14-Mock 补 61 条规则数、 独立端口 8798/OPSXAPI_MOCK_ADDR、Mock 管理页、Bearer 与来源控制、一键建 Mock - 新增 21-授权与激活 文档（试用条款/LIC- vs LICOFF-/解绑/离线容忍/防伪）并注册目录 - 21 页文档全量重建；7 页零断链验证 + DOM 结构核验（卡片/图标/药丸计数）通过
This commit is contained in:
logan committed
1 parent
904a85ab7f
commit
cdaba44373
32 files changed
+265
-80
No files matched your search
@@ -1,22 +1,26 @@
|
||||
OpsxAPI 主界面分为五个区域：
|
||||
OpsxAPI 主界面由「活动栏 + 顶栏 + 侧栏 + 标签页 + 编辑区」组成：
|
||||
|
||||
## 活动栏（最左窄栏）
|
||||
|
||||
| 元素 | 作用 |
|
||||
| --- | --- |
|
||||
| 空间徽标（顶部） | 切换 本地空间 / 我的空间 / 团队空间；云端空间显示同步状态点 |
|
||||
| 接口 / 历史 / 测试 / 文档 / Mock | 主导航：接口工作台、请求历史、自动化测试、接口文档、Mock 管理 |
|
||||
| 授权徽章 | 试用倒计时或已授权状态，点击进入 设置 → 授权 |
|
||||
| 设置 / 账号 | 设置中心；账号菜单（团队管理、立即同步、退出登录） |
|
||||
|
||||
## 顶栏
|
||||
|
||||
| 元素 | 作用 |
|
||||
| --- | --- |
|
||||
| ＋ 新建 | 快捷创建各协议请求 / 目录（默认建在第一个集合） |
|
||||
| 导入 / 导出 | 打开数据导入、导出对话框 |
|
||||
| 环境选择器 | 切换当前环境（变量随之生效），「⚙ 环境」管理环境与变量 |
|
||||
| 🌙 / ☀️ | 明暗主题切换 |
|
||||
| ⋯ | 设置（主题、超时、重置工作区） |
|
||||
| ＋ 新建 | 六种协议请求 / 目录（默认建在第一个集合） |
|
||||
| 导入 / 导出 | 数据导入（十种格式）与导出对话框 |
|
||||
| 环境选择器 | 切换当前环境（变量与前置 URL 随之生效），可直达环境管理 |
|
||||
|
||||
## 左侧集合树
|
||||
## 左侧栏（接口 | 历史 分段）
|
||||
|
||||
- 点击请求 → 在标签页中打开；点击目录 → 展开 / 折叠。
|
||||
- **右键**任意节点：新建、重命名、复制、导出、删除。
|
||||
- **拖拽**请求或目录到另一个目录，即可移动（支持跨集合）。
|
||||
- 顶部搜索框按名称 / 方法 / URL 实时过滤。
|
||||
- 底部为**历史记录**：显示最近请求的状态码与耗时，点击可回跳到对应接口。
|
||||
- **接口**：集合树 — 点击请求在标签页打开，目录展开 / 折叠；**右键** 新建 / 重命名 / 复制 / 导出 / 删除；**拖拽**移动（支持跨集合）；顶部搜索实时过滤。
|
||||
- **历史**：最近请求自动归档（状态码 / 耗时），点击回跳对应接口，支持一键清空。
|
||||
|
||||
## 标签页栏
|
||||
|
||||
|
||||
@@ -7,11 +7,11 @@
|
||||
|
||||
## 开启与配置
|
||||
|
||||
顶栏 **⋯ → Mock 数据**（或「设置 → Mock 数据」）：
|
||||
「设置 → 数据生成」（或请求编辑器的 Mock 工具按钮）：
|
||||
|
||||
- **启用 Mock 数据**：总开关，关闭后 `@` 表达式按普通文本原样发送；
|
||||
- **智能 Mock 匹配**：JSON Body 字段值未写表达式时，按字段名匹配规则自动生成；
|
||||
- **智能匹配规则表**：数据类型（string / number / integer / boolean）、匹配方式（通配符 / 完全匹配 / 正则）、匹配规则（如 `*name*`）、Mock 表达式、备注与启用开关，支持搜索、新增、删除与恢复默认。
|
||||
- **智能匹配规则表**：内置 **61 条**默认规则（用户名、邮箱、手机号、价格、时间戳……），数据类型（string / number / integer / boolean）、匹配方式（通配符 / 完全匹配 / 正则）、匹配规则（如 `*name*`）、Mock 表达式、备注与启用开关，支持搜索、新增、删除与恢复默认。
|
||||
|
||||
规则**从上到下**匹配，先命中先用；类型需与 JSON 字段实际类型一致（KV 参数一律按 string 匹配）。
|
||||
|
||||
@@ -81,6 +81,10 @@ Body 工具栏提供两个辅助按钮：
|
||||
|
||||
特点：
|
||||
|
||||
- **独立监听端口**：Mock 服务默认跑在 `0.0.0.0:8798`（可用环境变量 `OPSXAPI_MOCK_ADDR` 修改），与主服务 8787 分离，内网同事按 `http://本机内网IP:8798/mock/{地址}{路径}` 直连；
|
||||
- **Mock 管理页**：活动栏「Mock」视图集中管理已发布路由 —— 方法 / 路径 / 状态码 / 响应格式 / 延迟（0–5s）/ 启用开关，支持保存草稿、一键发布全部、试运行与 GET /demo 示例；
|
||||
- **访问控制**：可开启 Bearer 密钥校验（只存摘要、可随时替换）；来源默认仅本机与内网网段，公网访问需显式设置 `OPSXAPI_MOCK_ALLOW_PUBLIC=1`；
|
||||
- **一键建 Mock**：HTTP 编辑器可「用本次响应创建 Mock」，把真实返回直接变成 Mock 模板；
|
||||
- **每次请求随机生成**：响应模板里的 `@cname`、`@integer(...)` 等表达式由服务端实时求值；
|
||||
- 发布时自动把智能 Mock 规则烘焙进模板（开启智能匹配时）；
|
||||
- 非 GET 接口可用 `?_method=POST` 快速验证；延迟最高 5 秒，用于模拟慢接口 / loading 态。
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
## 场景用例
|
||||
|
||||
从侧栏底部「自动化测试」进入。用例 = 有序步骤列表，每个步骤：
|
||||
从活动栏「测试」进入。用例 = 有序步骤列表，每个步骤：
|
||||
|
||||
- **引用一个 HTTP 接口**（从集合中选择，可跨集合、跨目录）；
|
||||
- **断言**：状态码 / 耗时 / Header / Body 四类目标，支持 等于、不等于、大于、小于、包含、存在 与 **JSONPath** 取值比较；
|
||||
@@ -23,15 +23,17 @@
|
||||
|
||||
- 统计卡：通过 / 失败步骤数、总耗时、断言数、通过率；
|
||||
- 步骤明细：方法 + URL + 状态码 + 耗时，逐条断言的期望 / 实际对照（可按 通过 / 失败 过滤）；
|
||||
- 「再次运行」一键回归；「导出报告」生成 Markdown 存档或归档到缺陷单；
|
||||
- 「再次运行」一键回归；「导出报告」生成 Markdown（含断言对照表，适合贴缺陷单）或 JSON（`opsxapi.test-run.v1` 结构，供 CI / 脚本二次处理）；
|
||||
- 每个用例保留最近 50 次运行记录，可下拉切换历史报告。
|
||||
|
||||
## 定时任务
|
||||
|
||||
用例头部的 ⏱ 按钮或左侧「定时任务」入口：
|
||||
用例头部的 ⏱ 按钮或左侧「定时任务」入口，两种节奏：
|
||||
|
||||
- 间隔可选 5 / 15 / 30 / 60 分钟、6 小时、每天；
|
||||
- **固定间隔**：5 / 15 / 30 / 60 分钟 · 6 小时 · 每天；
|
||||
- **Cron 表达式**：标准 5 段（分 时 日 月 周，本地时区），例如每 15 分钟 `*/15 * * * *`、每个工作日 9 点半 `30 9 * * 1-5`；
|
||||
- 独立 启用 / 暂停 开关，显示下次运行时间与上次结果；
|
||||
- 调度器每 15 秒巡检一次，同一用例运行中不会重复触发；每个任务环形保留最近 30 条运行日志；
|
||||
- **应用保持运行时生效**：OpsxAPI 窗口（或 Web 页面）开着才会按时触发并记录报告，关闭后自动暂停 —— 适合工作时段的持续监控，不能替代服务器侧的 CI。
|
||||
|
||||
> 提示：定时触发的请求同样走当前环境与 Mock 设置；跨环境回归前先在顶栏切换环境。
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# 授权与激活
|
||||
|
||||
OpsxAPI 桌面版采用「**先试用、后授权**」模式：**30 天全功能试用**从应用首次启动自动开始，无需注册账号、无需信用卡。试用期结束后，个人非商业用途可继续使用；在工作中商用需购买授权（[查看定价](/pricing)）。
|
||||
|
||||
## 两种授权码
|
||||
|
||||
| 类型 | 前缀 | 激活方式 | 适合 |
|
||||
| --- | --- | --- | --- |
|
||||
| 在线授权 | `LIC-` | 联网激活，绑定设备，支持自助解绑换机 | 有网络的日常环境 |
|
||||
| 离线许可证 | `LICOFF-` | 本地验签激活，同样绑定设备 | 隔离内网 / 完全无网络 |
|
||||
|
||||
## 激活步骤
|
||||
|
||||
1. 复制授权码（购买后邮件发放，形如 `LIC-2026-XXXX-XXXX-XXXX`）；
|
||||
2. 打开 **设置 → 授权**，粘贴到「激活许可证」输入框（邮箱可选，用于授权关联）；
|
||||
3. 点击「激活」。在线授权会联系授权服务器校验；离线许可证全程不联网，本地 Ed25519 验签即通过。
|
||||
|
||||
激活成功后，活动栏授权徽章变为绿色「已授权」，面板显示计划类型、到期时间与设备数。
|
||||
|
||||
## 状态与规则
|
||||
|
||||
- **设备绑定**：授权绑定设备而非账号。包年 3 台、永久 5 台；在 设置 → 授权 点「解绑本机」可迁移到新机器；
|
||||
- **离线容忍**：在线授权连续 30 天无法联网验证时需重新联网一次；离线许可证本地自验、永不联网也有效；
|
||||
- **防伪验证**：服务器响应带 Ed25519 签名，客户端内置公钥校验，防假服务器与篡改缓存；本机时钟明显回拨时拒绝激活；
|
||||
- **周期校验**：激活后应用每周静默验证一次，授权被吊销会自动降级为未授权状态。
|
||||
|
||||
## 常见问题
|
||||
|
||||
- **换电脑怎么办？** 旧机器 解绑本机 → 新机器粘贴同一授权码激活。
|
||||
- **离线证能用多久？** 最长 365 天，到期后在管理端重签新序列号（可同设备）。
|
||||
- **试用期到了功能会被锁吗？** 不会硬锁。个人非商业继续使用；商用请授权。
|
||||
@@ -137,6 +137,12 @@
|
||||
{
|
||||
"name": "参考",
|
||||
"pages": [
|
||||
{
|
||||
"file": "21-license.md",
|
||||
"slug": "license",
|
||||
"title": "授权与激活",
|
||||
"updated": "2026-10-16"
|
||||
},
|
||||
{
|
||||
"file": "18-server-api.md",
|
||||
"slug": "server-api",
|
||||
|
||||
Reference in new issue
Block a user