Apifox集成Jenkins教程

冰火之心

冰火之心

2026-06-23

252人浏览

原创

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

apifox集成jenkins教程 - php中文网

把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(接口调试工具)
Apifox(接口调试工具)

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应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

jenkins apifox

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Apifox接口调试教程大全
Apifox接口调试教程大全

Apifox接口调试专题覆盖 HTTP 请求发送、请求头、Query参数、Body请求体、Cookie、鉴权、响应校验、前置脚本、后置脚本和接口用例管理,帮助开发和测试人员在同一工具中完成接口调试、问题定位和前后端联调,减少 Postman 与文档工具之间的数据重复维护。

2026.06.23

43

10

Apifox自动化测试教程
Apifox自动化测试教程

Apifox自动化测试专题围绕接口测试场景编排、测试步骤、断言、变量提取、数据驱动、数据库校验、测试报告和 Apifox CLI 持续集成展开,适合测试工程师和研发团队构建 API 回归测试流程,并与 Jenkins、GitLab CI 等流水线结合提升接口质量保障效率。

2026.06.23

60

10

Apifox迁移协作指南
Apifox迁移协作指南

Apifox迁移协作专题覆盖 Swagger、OpenAPI、Postman、YApi、Eolink、Knife4j、HAR 等数据导入导出,讲解团队权限、项目成员、接口变更同步、数据备份、私有化部署和企业协作管理,适合从旧接口工具迁移到 Apifox 的团队规划统一 API 管理平台。

2026.06.24

49

10

Qt Creator编译运行使用教程
Qt Creator编译运行使用教程

围绕 Qt Creator 编译、运行、构建错误、断点调试、变量查看、调用栈、Debug与Release切换、编译输出和运行日志展开,帮助用户处理程序无法运行、断点不生效、找不到库文件、构建失败等问题。

2026.08.05

0

10

Qt Creator按钮响应设置方法
Qt Creator按钮响应设置方法

信号槽是 Qt 开发的核心机制。本专题整理 Qt Creator 中按钮点击、菜单触发、输入变化、窗口事件、自定义信号、自动连接槽函数和手动 connect 写法,帮助用户理解界面控件如何和 C++ 代码联动。

2026.08.05

0

10

Qt Creator新建项目使用教程
Qt Creator新建项目使用教程

本专题整理 Qt Creator 新建项目、打开已有工程、项目模板选择、目录结构、源文件管理、构建目录、运行配置和项目迁移方法,重点解决新手不知道选 qmake 还是 CMake、项目打不开、文件不参与编译等常见问题。

2026.08.05

0

10

maven常用插件使用大全
maven常用插件使用大全

PHP中文网精心整理Maven主流插件用法合集,涵盖编译、测试、打包等常用插件使用大全。从基础配置到进阶实战,详细解析各插件功能与适用场景,助你轻松掌握Maven自动化构建,解决Java项目开发痛点,是开发者必备的实用指南。

2026.08.05

0

31

PyCharm快速入门指南
PyCharm快速入门指南

本专题汇总了PyCharm快速入门的全套指南与教程,涵盖从官网下载安装、创建第一个Python项目、配置虚拟环境,到代码编辑、运行调试等基础操作,并整理了版本控制(Git)集成、常用高效快捷键及实用插件等进阶技巧,助你快速上手这款高效的Python IDE。

2026.08.05

2

17

PyCharm运行程序教程大全
PyCharm运行程序教程大全

本专题汇总了PyCharm运行程序的多种方式与详细操作步骤,涵盖通过主菜单Run、点击工具栏绿色三角图标、使用快捷键Shift+F10(或Ctrl+Shift+F10)等基本运行方法,以及配置运行/调试参数、设置PYTHONPATH环境变量、管理多脚本运行与交互式Python控制台调试等进阶技巧,助您全面掌握在PyCharm中高效运行与管理Python程序的方法。

2026.08.05

0

14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Apifox CLI官方手册
Apifox CLI官方手册

共0课时 | 0人学习

Apifox下载与安装手册
Apifox下载与安装手册

共0课时 | 0人学习

Apifox官方手册
Apifox官方手册

共0课时 | 0人学习