apifox接口自动化测试接入jenkins流水线需三步:一是jenkins服务器安装node.js(v16.14.0,禁用18.x)并全局安装apifox-cli;二是在apifox中创建含登录链路的测试场景,配置好环境与变量后通过ci/cd页复制标准cli命令;三是在jenkins pipeline中嵌入该命令,配合布尔参数控制执行、html报告归档及在线查看。

把Apifox写的接口自动化测试加进Jenkins流水线,让每次代码提交后自动跑一遍API用例,发现鉴权失效、字段缺失、状态码错乱等问题立刻告警,不用等测试同学手动点运行——这一步必须在Jenkins能调起apifox-cli的前提下做,否则命令执行会直接报“command not found”。
前置环境准备:Jenkins服务器装好Node.js和apifox-cli
登录Jenkins所在服务器,确认Node.js版本不低于16.14.0(【18.x及以上版本不兼容apifox-cli】):
node -v
若未安装或版本过低,执行:
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - && sudo apt-get install -y nodejs
全局安装apifox-cli(必须用root或sudo权限,否则Jenkins job无法调用):
npm install -g apifox-cli
验证是否可用:
apifox --version
如果返回版本号(如 v1.12.3),说明CLI已就绪;若提示“command not found”,需检查npm全局bin路径是否加入系统PATH,常见路径是 /usr/local/bin 或 /root/.npm-global/bin,把它写进 /etc/profile.d/apifox.sh 并 source 生效。
Apifox端生成可执行的CI命令
打开Apifox项目 → 左侧菜单【自动化测试】→ 点击右上角【+新建场景】→ 填写名称(如“prod-login-flow”)→ 【保存】。
点击该场景 → 【添加步骤】→ 推荐选【从接口用例导入】,勾选包含登录、获取用户信息、修改头像等完整链路的用例 → 确保登录接口排在第一步(后续所有请求依赖它返回的token)。
Apifox是一款拥有可视化管理界面的接口开发调试工具,支持接口调试,自动校验数据结构,自动化测试等功能,能够帮助用户更好的测试API,能够有效提高团队的办公效率,有需要的用户欢迎下载使用!功能介绍可视化接口管理方便快捷可视化接口管理,成倍提升团队多人协作效率。支持数据结构(JSON Schema)管理,多接口可复用相同数据结构。接口调试Postman 有的功能,比如环境变量、预执行脚本、后执行脚本、Cookie/Session 全局共享 等功能,Apifox 都有,并且和 Postman 一样高效好用。
点击【运行环境】下拉框 → 选择已配置好的生产环境(环境里必须含正确的base_url、Authorization模板、必要变量如{{username}}/{{password}})。
点击右上角【CI/CD】标签页 → 在“Jenkins”平台卡片下点击【复制命令】→ 得到形如 apifox test xxxxxxxx --env=prod --reporter=html 的完整命令。
【复制前务必点一次【本地运行】,确保场景能绿色通过,否则Jenkins里失败你得倒查三遍】
Jenkins流水线中嵌入Apifox测试
进入Jenkins → 新建任务 → 输入名称 → 选择【流水线】→ 【确定】。
向下滚动到【流水线】区域 → 选择【Pipeline script】→ 粘贴以下结构化脚本(注意替换 YOUR_APIFOX_COMMAND):
pipeline {
agent any
environment {
NODEJS_HOME = "/usr/bin/node" // 根据实际node路径调整
}
stages {
stage('API Test') {
steps {
script {
if (params.run_apifox == true) {
sh 'apifox test xxxxxxxx --env=prod --reporter=html --output=./apifox-report'
}
}
}
}
}
post {
always {
archiveArtifacts artifacts: 'apifox-report/**', fingerprint: true
}
}
}
回到任务配置页顶部 → 勾选【此项目参数化构建过程】→ 添加参数 → 选择【布尔参数】→ 名称填 run_apifox → 默认值设为 false → 描述写“勾选则执行Apifox接口测试”。
保存后,首次构建时勾选该复选框 → 构建开始 → 查看Console Output,滚动到底部能看到 apifox test 启动日志和最终 PASS/FAIL 结果。
查看并归档测试报告
构建成功后,在左侧菜单点击【apifox-report】→ 进入归档页面 → 点击最新一次构建编号 → 右侧【Build Artifacts】里找到 index.html → 点击即可在线查看带图表、用例列表、失败详情的完整HTML报告。
若想让报告长期可访问,需额外配置Nginx反向代理指向 ./apifox-report 目录(端口建议避开8080,比如用2588),否则Jenkins默认只保留最近几次构建的归档。
不需要手动清理旧报告——Jenkins内置的“丢弃旧的构建”策略会自动处理,但要注意:apifox-cli生成的 report 文件夹内含大量JS/CSS资源,单次报告体积常超10MB,磁盘空间吃紧时建议在post阶段加shell命令压缩后再归档。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!










