Apifox CLI怎么用?

轻敏君_1221

轻敏君_1221

2026-06-23

1036人浏览

原创

Apifox接口测试必须通过CLI调用云端测试计划URL,不可执行本地JSON文件;需安装≥v1.12.0的apifox-cli(Node.js≥v16.14.0),获取72小时内有效的运行URL,支持直接运行、参数分离或环境变量方式触发,并通过--report-json导出JUnit兼容报告。

apifox cli怎么用? - php中文网

要在CI/CD流水线中自动运行Apifox接口测试用例,必须通过Apifox CLI调用云端测试计划,本地无法直接执行导出的JSON测试文件——因为CLI不解析本地JSON,只认Apifox平台生成的唯一运行URL。

安装与验证CLI环境

打开终端,执行 npm install -g apifox-cli 全局安装工具。安装完成后运行 apifox --version,确认输出版本号且不低于 v1.12.0。

【Node.js 版本必须 ≥ v16.14.0】 低于此版本会导致 token 自动刷新失败或签名计算异常,建议使用 nvm 管理多版本并切换至 LTS(如 v18.x)。

执行 npm list -g apifox-cli 查看是否已成功安装在全局路径下,若提示“empty”,说明未安装成功或权限被拒绝,需加 sudo(macOS/Linux)或以管理员身份运行 PowerShell(Windows)重试。

获取测试用例的运行URL

登录 Apifox Web 控制台 → 进入目标项目 → 左侧导航栏点击「自动化测试」→ 找到要集成的测试场景或单接口用例 → 点击右侧「⋯」→ 选择「持续集成」。

在弹出窗口中点击「新建」→ 填写名称(如 ci-prod-login-test)→ 选择运行环境(务必与测试目标一致)→ 设置循环次数、线程数等参数 → 点击「保存」。

保存后,页面会自动生成一条形如 https://run.apifox.cn/xxxxx?token=yyyyy 的 URL,【此URL含短期时效 token,72 小时内有效,不可截图长期复用】。

命令行触发测试执行

方法一:直接运行(适合调试)
在终端中粘贴完整 URL 并执行:apifox run "https://run.apifox.cn/xxx?token=yyy"

Apifox CLI
Apifox CLI

Apifox CLI 是一个命令行工具,旨在执行和测试你的场景用例。它经过优化,具备高度的扩展性,可以轻松集成到你的持续集成 (CI) 服务器和构建系统中。

下载

方法二:分离参数(适合脚本化)
将 URL 拆为两部分:apifox run --url https://run.apifox.cn/xxx --token yyy

方法三:从环境变量注入(推荐用于 Jenkins/GitLab CI)
先设置:export APIFOX_RUN_URL="https://run.apifox.cn/xxx" 和 export APIFOX_RUN_TOKEN="yyy",再执行:apifox run --url $APIFOX_RUN_URL --token $APIFOX_RUN_TOKEN。

执行后终端实时输出请求日志、断言结果与汇总统计;若某步骤失败,会明确标出失败接口名及断言错误详情,无需打开网页查看。

解析并提取测试结果

添加 --report-json ./report.json 参数,即可将完整执行结果(含每个步骤耗时、状态码、断言通过率、错误堆栈)导出为标准 JSON 文件。

该 JSON 结构兼容 JUnit XML 格式,可直接被 Jenkins 的 JUnit 插件解析,生成可视化趋势图与失败明细。

注意:若未加 --report-json,CLI 默认仅输出控制台日志,【不会自动生成任何本地报告文件】,CI 流水线中必须显式声明导出路径。

执行完成后检查 report.json 是否生成且非空;若文件为空或报错 “EACCES: permission denied”,说明当前用户无写入权限,需改用绝对路径如 /tmp/apifox-report.json 或提前创建目录并赋权。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

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

相关专题

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

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

2026.06.23

609

10

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

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

2026.06.23

645

10

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

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

2026.06.24

602

10

Tailwind CSS 如何制作导航栏和卡片
Tailwind CSS 如何制作导航栏和卡片

用 Tailwind CSS 制作导航栏和卡片,可先搭建语义化结构,再组合 Flex、Grid、间距、圆角与阴影类。这里整理横向导航、移动端菜单、卡片网格及悬停效果的相关文章,帮助你把常见页面组件做得清晰且适配不同屏幕。

2026.11.03

0

17

Tailwind CSS 响应式布局怎么写
Tailwind CSS 响应式布局怎么写

Tailwind CSS 响应式布局通常从移动端样式写起,再用 sm、md、lg 等前缀调整不同屏幕宽度下的网格、间距和导航。本专题整理断点配置、Grid 与 Flex 自适应布局及常见溢出问题,帮助你逐步完成多设备适配。

2026.11.03

0

19

Tailwind CSS 常用类名怎么记
Tailwind CSS 常用类名怎么记

Tailwind CSS 类名很多,先按布局、间距、文字、颜色和状态分组记忆,再通过官方文档检索具体写法。本专题结合类名排序、动态拼接失效、自定义实用类等问题,帮助你建立常用类名的速查方法。

2026.11.03

0

12

码上飞入口地址合集
码上飞入口地址合集

本专题汇总了码上飞(CodeFlying)的官方入口地址合集,涵盖官网主站及网页版在线使用入口,支持注册登录后直接在线体验零代码AI应用生成。同时整理了APP端下载渠道与小程序入口,助你快速访问平台,通过自然语言描述需求即可生成应用、小程序或网站。

2026.11.03

0

10

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

2026.11.02

20

14

Uvicorn使用教程
Uvicorn使用教程

本专题汇总了Uvicorn使用教程与启动运行指南,涵盖其作为Python ASGI服务器的定位与特点,以及命令行启动(uvicorn main:app --reload)、参数配置(host/port/workers)、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧,助你快速掌握Uvicorn的运行与配置。

2026.11.02

20

17

热门下载

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

精品课程

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

共0课时 | 0人学习