安装和运行 CLI

Apifox CLI 是一个命令行工具，用来运行 Apifox 的测试场景。使用前需要先装好 Node.js，再装 Apifox CLI，然后即可进行测试。

安装 Apifox CLI

Apifox CLI 是基于 Node.js 开发的，所以得先装好 Node.js。

Apifox CLI 要求 Node.js 版本不能低于 v16。

在系统上全局安装 Apifox CLI，这样就能在任何地方运行它。

国内镜像源

npm 源命令

可以通过以下命令确认是否安装成功。

如果安装成功，运行上面的命令后会直接显示版本号和安装路径。

更新 Apifox CLI

用下面的命令可以升级 Apifox CLI。

运行 Apifox CLI

要用 Apifox CLI 跑测试场景，得先创建并编排好测试场景。之后就能像在图形界面一样，在命令行中运行测试场景并得到测试报告。

Apifox CLI 支持两种运行方式：

运行在线数据：适合实时场景

导出数据运行：适合离线场景

运行在线数据

在测试场景中，切换到 CI/CD 标签页。

配置运行环境、测试数据、循环次数、间隔停顿时间等。

在 CI/CD 平台中，选择 “CLI 命令行”。

点击 “添加 Access Token” 按钮，然后 “生成 Token”。

了解更多关于访问令牌的信息。

点击命令复制。

把命令粘贴到命令行中运行，即可在命令行看到测试报告。

第二步中，在界面内的设置会自动影响下方 CLI 使用的选项及值：

运行环境，影响 -e <environmentId>

测试数据，影响 -d <testDataId>

循环次数，影响 -n <n>

间隔停顿，影响 --delay-request <n>

环境/全局变量值，如果选择 “导出本地值使用”，则可以在界面发现导出入口将当前项目的环境/全局变量本地值导出到文件内，并且影响 --variables <path>。需要将这个导出文件放到 CLI 运行机器内，并将此文件路径填入 --variables <path> 中。关于 “使用远程值” 和 “导出本地值使用” 的区别，在此处了解更多。

如果你的测试场景中同时使用了保存在本地的数据库连接配置，则产品界面会引导导出配置到本地文件，并且影响 --database-connection <path>。需要将这个导出文件放到 CLI 运行机器内，并将此文件路径填入 --database-connection <path> 中。

导出数据运行

在测试场景中，切换到 CI/CD 标签页。

配置运行环境、测试数据、循环次数、间隔停顿时间等。

在 CI/CD 平台中，选择 “CLI 命令行”，然后切换到 “导出数据运行”。

把测试场景导出成 JSON 文件。

复制下方显示的命令。

把命令粘贴到命令行中运行，即可看到命令行测试报告。

第二步中，在界面内的设置如 “运行在线数据” 一样会自动影响下方 CLI 使用的选项及值。需要注意的是通过此种方式运行，环境/全局变量使用的是随测试场景一起导出的文件内的值。在此处了解更多。

CLI 测试报告

跑完 CLI 后，你会得到一份命令行测试报告，包含测试场景的执行统计数据，以及失败请求的验证和断言信息。

在运行 CLI 的文件夹里还能找到 /apifox-reports/ 目录，里面有 HTML 格式的 CLI 测试报告。

命令选项

Apifox CLI 提供了丰富的配置选项来自定义测试集合的运行。详情可以看 CLI 命令选项。

在 CI/CD 中使用 Apifox CLI

Apifox CLI 支持和各种流水线工具集成，比如 Jenkins、GitLab、GitHub Actions 等。想了解更多可以看看 CI/CD 集成。

安装 Apifox CLI#

更新 Apifox CLI#

运行 Apifox CLI#

运行在线数据#

导出数据运行#

CLI 测试报告#

命令选项#

在 CI/CD 中使用 Apifox CLI#

安装 Apifox CLI

更新 Apifox CLI

运行 Apifox CLI

运行在线数据

导出数据运行

CLI 测试报告

命令选项

在 CI/CD 中使用 Apifox CLI