讲师中心 微信公众号
AI工具推荐 视频效率加速

Apifox CLI怎么用?

轻敏君_1221

轻敏君_1221

发布时间:2026-06-23 18:23:30

|

996人浏览过

|

来源于php中文网

原创

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 或提前创建目录并赋权。

相关文章

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

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

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

469

2026.06.23

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

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

505

2026.06.23

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

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

422

2026.06.24

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

120

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

100

2026.09.30

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

80

2026.09.30

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

80

2026.09.30

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

100

2026.09.29

热门下载

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

精品课程

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

共0课时 | 0人学习

Apifox CLI官方手册
Apifox CLI官方手册

共0课时 | 0人学习

Apifox CLI官方手册
Apifox CLI官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn