ApiChain 是一款开源、支持内网私有化部署的接口文档管理与自动化测试工具。核心设计思路是以迭代为单位管理接口,迭代结束后合并到项目基线库,形成可持续运行的回归测试集。
onlinetool/apichain
ApiChain 的组织结构是「项目 → 迭代 → 接口用例」。
这样做的好处是:迭代过程中文档可以灵活变动,上线后又不会丢失版本记录。
支持三级变量隔离:全局变量 → 项目环境 → 迭代环境。开发、测试、预发各用各的变量,互不干扰。
支持按顺序执行多条接口,自动提取上一步返回的 Cookie、Header、JSON 字段传给下游接口。内置随机参数和时间戳生成,测试数据不固化,用例可反复执行。
除常规的 HTTP 响应校验外,支持直连 MySQL 执行 SQL 查询,将数据库实际数据与接口返回值做比对。测试完成后可自动清理测试数据。适用于需要验证数据一致性的场景(如资金、库存相关接口)。
接入大模型向量检索,支持用自然语言搜索接口,不需要精确匹配关键字。同时可根据 JSON 报文自动生成字段注释和后端实体类代码。
迭代文档可关联需求链接、UI 稿、数据库脚本、配置变更记录。一份文档覆盖本次迭代的全部变更内容。
内网部署 Runner 服务后,团队成员共享项目与接口文档。支持在浏览器中直接打开文档并发起请求,不要求全员安装客户端。
新建项目 → 划分迭代
→ 在迭代下添加接口、调试、编写用例
→ 配置断言(响应校验 + SQL 校验),执行自动化测试
→ 迭代上线,一键合并接口到项目基线库
→ 后续迭代完成后,运行基线用例做全量回归
| 方式 | 说明 |
|---|---|
| 在线链接 | 生成内网临时 URL,浏览器直接查看,可在线调试 |
| 离线导出 | 批量导出 Markdown / 静态 HTML |
| 数据兼容 | 支持导入/导出 Postman 集合 |
| 维度 | ApiChain | Apifox / Postman |
|---|---|---|
| 管理维度 | 迭代 + 项目双轨,版本可追溯 | 按项目分组,迭代文档需手动归档 |
| 断言能力 | 接口响应 + MySQL 数据库校验 | 主要基于 HTTP 响应校验 |
| 私有化部署 | 免费,Docker 部署,数据留内网 | 私有化版本需付费 |
| 回归测试 | 迭代接口一键合并为回归套件 | 用例需手动维护 |
| AI 能力 | 语义检索 + 自动生成字段注释 | JSON 示例生成 |
需要说明的是,Apifox / Postman 在前端 Mock、协议支持广度、插件生态方面更成熟。ApiChain 侧重的是迭代管理和回归测试这个方向,两者定位不完全相同。