🚀 开启 ApiChain 体验之旅

ApiChain:以迭代为核心的微服务接口管理与测试平台，Postman/Apifox的开源替代品。支持数据库级深度断言、全链路接口串联与文档智能归并。>>

💡 为什么选择 ApiChain？

在日常研发与测试中，你是否常被以下痛点折磨？

1. 文档割裂：迭代开发时的接口文档与项目整体文档难以统一，合并全靠手动，极易遗漏。
2. 用例一次性：验证迭代功能的测试用例，因为数据写死，跑完一次就作废，无法反复执行。
3. 断言太浅：接口返回成功的 Code 码就真没问题了吗？底层数据库数据可能早已脏乱差，仅校验返回值根本无法保证正确性。
4. 回归盲盒：程序员改了新功能，却把旧功能搞坏，改动影响范围全靠猜，回归测试两眼一抹黑，线上事故频发。

ApiChain 直击以上痛点，为你提供“定义-测试-回归”的一体化闭环体验：

• 迭代文档自动归并：迭代内独立维护文档，上线后一键按微服务合并至项目，彻底告别文档割裂。
• 用例随心反复执行：内置随机字符串、时间戳等函数，无需手动修改数据，迭代用例想跑多少次就跑多少次。
• 接口与数据库双重断言：不仅能校验返回值，更能直连数据库校验实际数据变更，并自动清理脏数据，把隐患扼杀在摇篮。
• 精准拦截回归风险：将迭代用例导出至项目，一键执行项目级回归测试，让改动影响范围一目了然，为线上安全兜底。

🎯 本指南适用人群

• 后端/前端/测试工程师：渴望用一款工具彻底解决接口文档统一与深度自动化测试的痛点。
• 技术极客与效率控：对 ApiChain 的创新玩法感兴趣，想第一时间亲身体验。

🛠️ 体验之旅：四步玩转 ApiChain

为了让你在最短时间内感受 ApiChain 解决痛点的魅力，请跟随以下步骤完成部署与实战。

第一步：搭建数据底座（准备 MySQL）

你需要一个 MySQL 8.x 数据库。如果尚未安装，可通过以下 Docker 脚本极速启动（⚠️ 生产环境请务必做好权限隔离与持久化配置）：

docker pull mysql:8.0

docker run --name mysql-container -p 33088:3306 -e MYSQL_ROOT_PASSWORD=112233 -d mysql:8.0

启动后，请记录以下环境变量信息，后续将频繁使用：

• DB_HOST（主机地址，如 192.168.1.5）
• DB_PORT（端口，如 33088）
• DB_USER（用户名，如 root）
• DB_PASS（密码，如 112233）
• DB_NAME（数据库名，如 apichain）

💡 提示：提供的数据库账号需具备建表、改表及数据增删改查权限。如遇连接报错 Public Key Retrieval is not allowed，请将驱动属性中的 allowPublicKeyRetrieval 修改为 true。

接着，请手动创建数据库并导入测试数据：

1. 执行 SQL：create database apichain;
2. 下载测试数据脚本并导入：点此下载 SQL 文件

第二步：启动核心引擎（Runner）

准备好数据库后，修改以下命令中的数据库连接参数，一键启动本地 Runner 服务：

docker volume create apichain_cache_data;
docker pull registry.cn-shanghai.aliyuncs.com/apichain/runner:1.2.4;
docker run -d \
-p 6588:6588 \
-e DB_HOST=192.168.1.5 \
-e DB_PORT=33088 \
-e DB_USER=root \
-e DB_PASS=112233 \
-e DB_NAME=apichain \
-e DEPLOY_COUNTRY=CN \
-e APICHAIN_SUPER_UID=44470bb9b4f8d601f812945fe275e139 \
-v apichain_cache_data:/opt/cache \
--name apichain-runner \
registry.cn-shanghai.aliyuncs.com/apichain/runner:1.2.4

第三步：客户端连接 Runner

1. 打开 ApiChain 客户端，点击右上角切换至你熟悉的语言。
2. 点击单机版，选择联网版。
3. 填写服务器地址（如 http://127.0.0.1:6588），点击检测确保网络畅通。
4. 选择加入团队 -> 选择 runner开发者 团队 -> 点击加入。
5. 🎉 因为你使用了超管 UID 启动，无需审批直接入团！重启 ApiChain 即可正式开启体验。

第四步：核心功能漫游

入团后，建议按照以下路径探索产品核心逻辑：

1. 亮明身份：点击顶部昵称旁的编辑按钮，修改你在团队内的称呼。
2. 配置开发环境：进入 设置 - 开发环境，这里是接口请求与自动化测试的变量数据源（同 Runner 下团队共享）。

3. 查看项目与迭代：

   • 设置 - 项目：团队微服务列表。
   • 设置 - 版本迭代：开发周期管理。每个迭代可记录文档链接、上线分支、数据库配置等信息。
4. 接口文档与调试：进入 项目 - 文档，按文件夹分类查看所有接口详情，并可直接发送请求调试。
5. 项目环境配置：进入 项目 - 设置，配置不同环境下的接口地址与数据库信息（数据库密码加密存储，用于后续断言与脏数据清理）。

🎯 实战演练：直击四大痛点

为了让你切实体验 ApiChain 如何解决核心痛点，我们准备了以下实战环节。首先，我们需要补全项目的数据库连接配置，这是实现数据库深度校验的前提。

1. 修正项目数据库连接（铺垫痛点3：数据库校验）

前往 项目菜单 - runner运行器 - 设置，选择本地环境，填写以下信息：

• 域名：Runner 的访问地址，以 / 结尾（如 http://192.168.1.5:6588/）
• 前缀：接口公共路径（此项目为空）
• 数据库信息：依次填入主机、端口、用户名、密码（加密保存）、名称（与第一步一致）

• 请求与执行端：

  • api请求发送端：选择“当前设备”从客户端发请求，或选“团队runner”解决封闭网络问题。
  • 数据库连接发送端：选择“当前设备”从客户端执行SQL，或选“团队runner”穿透网络限制。
• 点击底部修改按钮保存。

2. 运行项目单测（解决痛点4：告别回归盲盒）

进入 项目菜单 - runner运行器 - 单测，勾选 入团流程 用例，选择本地环境并点击执行用例：

• 🌟 体验重点：这是一个涵盖注册、申请、审批、权限变更等13个步骤的完整生命周期闭环。后面步骤依赖前面步骤的传参，且由随机数据作为初始触发条件。执行完成后，你能清晰看到每一步的入参、返回值及多重断言结果，精准拦截任何因改动引发的连锁风险。
• 🛠️ 继续体验：依次勾选 开发环境管理 / 项目测试 / 版本迭代 / 环境变量测试，体验不同场景下的项目级回归测试。

3. 执行迭代单测（解决痛点1、2、3：文档归并+反复执行+深度校验）

1. 在迭代菜单找到环境变量迭代。
2. 痛点1解决：点击文档菜单，这里是迭代开发的接口。体验一下：当迭代上线完成，关闭这个迭代时，这些接口会自动按微服务合并到项目中，彻底告别文档手动合并的痛苦！
3. 痛点2解决：点击单测菜单，执行环境变量测试用例。因为使用了随机初始数据，你可以反复执行，再也不用担心数据冲突导致用例作废。
4. 痛点3解决：在用例执行过程中，仔细查看每个步骤的断言！它不仅校验了接口返回的 Code 码，更直连数据库校验了全局、项目、迭代三级环境变量实际数据的相互影响。真正的数据级断言，让隐患无所遁形！

🌟 更多盲盒等你开启

以上只是 ApiChain 的冰山一角！现在，你可以自由点击其他菜单，探索示例项目中更多强大的配置与功能，感受前所未有的接口管理与测试流畅度。祝你体验愉快！