# ApiChain

**Repository Path**: onlinetool/apichain

## Basic Information

- **Project Name**: ApiChain
- **Description**: 以迭代为核心的微服务接口管理与测试平台，Postman/Apifox的开源替代品。支持数据库级深度断言、全链路接口串联与文档智能归并。
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 392
- **Forks**: 27
- **Created**: 2024-06-19
- **Last Updated**: 2026-07-02

## Categories & Tags

**Categories**: api-gateway

**Tags**: api管理, 接口测试, REST客户端, Postman替代工具, Apifox替代工具

## README

> 你见过这样的聊天软件吗？
>
> 你们可以一起聊工作问题，分析数据，讨论方案
>
> 也可以倾诉工作烦恼，聊聊职业规划，聊那些平时不太好说出口的不甘心
>
> 它不会只说一句‘别难过’，而是真的接住你的情绪
>
> 当然，也可以讲冷笑话，互相打趣
>
> 甚至，你可以在聊天里自然约 TA 去一个新的地方
>
> 点击右下角切换场景，系统会根据你们刚才的聊天，生成新的画面、新的开场白，让故事继续发生
>
> 它不是随机陪聊。CandyAI 会先通过三份心理测评理解你：价值观、人格、情感依恋模式
>
> 完成测评后，你只需要填写性别、职业、期望伴侣年龄、职业和彼此昵称，系统就会为你生成一个与你三观一致、能够情感共鸣的 AI 伴侣
>
> 登录也不需要手机号和邮箱。创建完成后，系统会给你 12 个词的助记词，之后凭助记词登录
>
> 如果你也想体验一个真正懂你的 AI 伴侣，[**点击这里**](https://candy.fanghailiang.cn/)，开始你的 CandyAI 旅程

# ApiChain — 接口文档管理工具

## 定位

ApiChain 是一款开源、支持内网私有化部署的接口文档管理与自动化测试工具。核心设计思路是**以迭代为单位管理接口**，迭代结束后合并到项目基线库，形成可持续运行的回归测试集。

- 开源地址：Gitee `onlinetool/apichain`
- 客户端：Windows / macOS / Linux
- 部署方式：单机本地使用，或内网团队部署（Docker，数据不出内网）

---

## 核心功能

### 1. 迭代 + 项目双轨管理

ApiChain 的组织结构是「项目 → 迭代 → 接口用例」。

- 每个迭代独立维护接口文档和调试用例
- 迭代上线后，一键将新增接口合并到项目基准库
- 项目库保存稳定版接口，作为长期回归基线
- 迭代文档支持生成临时分享链接，可导出 Markdown / HTML

这样做的好处是：迭代过程中文档可以灵活变动，上线后又不会丢失版本记录。

### 2. 多层级环境变量

支持三级变量隔离：全局变量 → 项目环境 → 迭代环境。开发、测试、预发各用各的变量，互不干扰。

### 3. 接口串联测试

支持按顺序执行多条接口，自动提取上一步返回的 Cookie、Header、JSON 字段传给下游接口。内置随机参数和时间戳生成，测试数据不固化，用例可反复执行。

### 4. 数据库断言

除常规的 HTTP 响应校验外，支持直连 MySQL 执行 SQL 查询，将数据库实际数据与接口返回值做比对。测试完成后可自动清理测试数据。适用于需要验证数据一致性的场景（如资金、库存相关接口）。

### 5. AI 语义检索

接入大模型向量检索，支持用自然语言搜索接口，不需要精确匹配关键字。同时可根据 JSON 报文自动生成字段注释和后端实体类代码。

### 6. 迭代文档整合

迭代文档可关联需求链接、UI 稿、数据库脚本、配置变更记录。一份文档覆盖本次迭代的全部变更内容。

### 7. 团队协作

内网部署 Runner 服务后，团队成员共享项目与接口文档。支持在浏览器中直接打开文档并发起请求，不要求全员安装客户端。

---

## 典型工作流

```
新建项目 → 划分迭代
  → 在迭代下添加接口、调试、编写用例
  → 配置断言（响应校验 + SQL 校验），执行自动化测试
  → 迭代上线，一键合并接口到项目基线库
  → 后续迭代完成后，运行基线用例做全量回归
```

---

## 文档导出与共享

| 方式     | 说明                                         |
| -------- | -------------------------------------------- |
| 在线链接 | 生成内网临时 URL，浏览器直接查看，可在线调试 |
| 离线导出 | 批量导出 Markdown / 静态 HTML                |
| 数据兼容 | 支持导入/导出 Postman 集合                   |

---

## 与 Apifox / Postman 的差异

| 维度       | ApiChain                      | Apifox / Postman               |
| ---------- | ----------------------------- | ------------------------------ |
| 管理维度   | 迭代 + 项目双轨，版本可追溯   | 按项目分组，迭代文档需手动归档 |
| 断言能力   | 接口响应 + MySQL 数据库校验   | 主要基于 HTTP 响应校验         |
| 私有化部署 | 免费，Docker 部署，数据留内网 | 私有化版本需付费               |
| 回归测试   | 迭代接口一键合并为回归套件    | 用例需手动维护                 |
| AI 能力    | 语义检索 + 自动生成字段注释   | JSON 示例生成                  |

需要说明的是，Apifox / Postman 在前端 Mock、协议支持广度、插件生态方面更成熟。ApiChain 侧重的是迭代管理和回归测试这个方向，两者定位不完全相同。

---

## 适用场景

- 迭代节奏较快的敏捷团队，需要持续做回归测试
- 微服务项目，接口多且变更频繁
- 对数据安全有要求，接口数据不能上传第三方平台
- 希望接口文档和测试用例统一管理，减少文档与代码脱节

---

## 当前的不足

- 暂未支持 OpenAPI（Swagger）双向同步
- 数据库断言仅支持 MySQL，不支持 Redis、MongoDB 等
- 前端 Mock 能力较弱，更偏后端接口管理与自动化测试