Apifox CLI 命令行运行

Apifox CLI 主要用来以命令行方式运行 Apifox 的 测试用例或测试套件。

开始

Apifox CLI 依赖于 Node.js >= v10。使用前请先安装 Node.js.

安装

使用以下命令安装 Apifox CLI

$ npm install -g apifox-cli

导出数据

在 Apifox 的测试用例和测试套件导出Apifox CLI格式数据。

注意

• Apifox 版本号大于等于 1.0.25 才支持导出Apifox CLI格式数据。
• 目前仅支持导出数据后离线运行，后续Apifox 开放 API发布后，可以直接运行在线实时数据。

运行测试用例或测试套件

$ apifox run examples/sample.apifox-cli.json -r cli,html

运行完成后测试报告会保存在当前目录下的apifox-reports目录里。

命令选项

apifox [options]

• -h, --help
  使用帮助

• -v, --version
  显示版本号

apifox run <file-source> [options]

file-source 为从 Apifox 导出的测试用例或测试套件数据文件存放路径。

更多选项：

  -r, --reporters [reporters]  指定测试报告类型 (default: ["cli"])
  -n, --iteration-count <n>    设置循环次数
  -d, --iteration-data <path>  设置用例循环额数据 (JSON 或 CSV)
  --ignore-redirects           阻止 Apifox 自动重定向返回 3XX 状态码的请求
  --silent                     阻止 Apifox CLI 输出到控制台
  --color <value>              开启/关闭控制台彩色输出 (auto|on|off) (default: "auto")
  --delay-request [n]          指定请求之间停顿间隔 (default: 0)
  --timeout-request [n]        指定接口请求超时时间 (default: 0)
  --timeout-script [n]         指定脚本预执行/后执行接口运行超时时间 (default: 0)
  --verbose                    显示所有接口请求的详细信息
  -h, --help                   使用帮助