Apifox 安装与部署
二、安装与部署
日常使用装桌面端即可;要在 CI 里跑自动化测试,再额外装命令行工具。
- 桌面端:从官网下载对应系统(Windows / macOS / Linux)的安装包,安装后注册账号并创建团队与项目。
- 创建项目与环境:在项目设置里建「测试环境」「预发环境」等,填写前置 URL(服务地址)。
- 导入既有接口:支持导入 OpenAPI / Postman / cURL / HAR,导入时选择「作为接口」或「作为测试用例」。
- 安装 CLI(做持续集成才需要):全局装
apifox-cli,它是基于 Node 的命令行工具。 - 拿到访问令牌:在个人设置里生成 access token,CLI 用它拉取云端测试场景。
- 跑一次:本地先手动跑通,再把它写进流水线。
# 安装命令行工具(需要 Node 环境)
npm install -g apifox-cli
# 验证
apifox --version
# 用访问令牌拉取指定测试场景并在本地执行
apifox run https://api.apifox.com/api/v1/projects/你的项目ID/api-test/export \
--access-token $APIFOX_TOKEN \
--environment 测试环境 \
--reporters cli,html \
--out-file report.html
依赖与系统要求:桌面端是独立客户端,无额外依赖;apifox-cli 需要 Node 运行环境(版本以官方文档为准);CI 里需要能访问 Apifox 云端接口,内网完全隔离的环境要考虑私有化部署方案,以官方文档为准。
| 报错 | 原因 | 处理 |
|---|---|---|
apifox: command not found | npm 全局 bin 目录不在 PATH 里 | 执行 npm bin -g 看路径并加入 PATH,或改用 npx apifox-cli |
Error: invalid access token | 令牌失效、复制时含空格、或不是该项目所属账号的令牌 | 重新生成令牌,用 CI 的密钥变量注入,不要写死在脚本里 |
| 拉取场景超时 / 网络失败 | CI 机器无外网访问,或走了代理未配置 | 配置代理环境变量,或改用导出好的场景文件离线执行 |
| Mock 服务 404 | 接口未开启 Mock,或本地 Mock 端口被占用 | 在接口设置里开启 Mock;换一个本地端口 |
| 自签证书报错 | 测试环境用了自签 HTTPS 证书 | 按官方 CLI 参数关闭证书校验,仅限内网测试环境使用 |

