Apifox CLI 命令行运行

Apifox CLI 主要用来以命令行方式运行 Apifox 的 测试场景。

开始

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

安装

使用以下命令安装 Apifox CLI

$ npm install -g apifox-cli

导出数据

在 Apifox 的测试场景导出Apifox CLI格式数据。

:::tip 注意

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

运行测试场景

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

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

• 如果想要自定义报告，可以通过 -r cli,json 获取 json 格式报告的结果集来定制自己想要的报告

命令选项

apifox [options]

• -h, --help
  使用帮助

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

apifox run [options]

file-source 为从 Apifox 导出的测试场景数据文件存放路径。

更多选项：

  --access-token           设置鉴权令牌，通过此令牌结合 -t/-f 命令来指定某个测试场景/测试场景目录运行
  -t, --test-scenario   指定测试场景 ID，通过 ID 运行相应的测试场景
  -f, --test-scenario-folder  指定测试场景目录 ID，通过目录 ID 运行相应的测试场景
  -r, --reporters [reporters]           指定测试报告类型, 支持 cli, html, json, junit (default: ["cli"])
  --out-dir                     输出测试报告目录，默认为当前目录下的 ./apifox-reports (default: "./apifox-reports")
  --out-file                   输出测试报告文件名，不需要添加后缀，默认格式为 apifox-report-{当前时间戳}-0 (default:
                                        "apifox-report-2022-10-25-15-03-08-247-0")
  -e, --environment                     指定运行环境，本次所有测试场景使用此环境运行
  -n, --iteration-count              设置循环次数
  -d, --iteration-data            设置用例循环的数据 (JSON 或 CSV)
  --env-var                  设置环境变量，使用 key=value 格式。可以设置多个环境变量。例如：--env-var "user=123" --env-var "password=123"
  --global-var               设置全局变量，使用 key=value 格式。可以设置多个全局变量。例如：--global-var "user=123" --global-var "password=123"
  --notification             运行完成后，通知指定对象。使用英文逗号添加多个通知对象 ID
  --notification-failed-event            运行完成后，仅失败时通知指定对象。使用英文逗号添加多个通知对象 ID
  --external-program-path