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

开始

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

安装

使用以下命令安装 Apifox CLI

$ npm install -g apifox-cli

实时运行在线数据

在 Apifox 的测试用例和测试套件选择持续集成，生成如下命令

" alt="Apifox CLI 命令行运行 开始 命令选项 " referrerPolicy="no-referrer" />

点击即复制命令，运行即可

apifox run http://xxx/api/v1/api-test/ci-config/xxxx/detail?token=xxxx -r html,cli

运行测试用例或测试套件

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

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

如果想要自定义报告，可以通过 json 文件的结果集来定制自己想要的报告

结合 Jenkins 做持续集成

Jenkins 集成 Apifox

CLI 如何实现文件参数传递

首先要回到接口文档-修改文档的请求参数处，通过批量编辑，把上传文件的路径改为变量。

" alt="Apifox CLI 命令行运行 开始 命令选项 " referrerPolicy="no-referrer" />

保存为接口用例后，再在 自动化测试 中导入 接口/接口用例 。

最后，去对应的应用中(比如 jenkins）运行时，修改这个路径变量的实际值。

命令选项

-h,--help使用帮助

-v,--version显示版本号

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

提示

--verbose在生成的测试报告中显示所有接口实际请求和响应

更多选项：

" alt="Apifox CLI 命令行运行 开始 命令选项 " referrerPolicy="no-referrer" />

SSL

客户端证书Apifox CLI 支持传入客户端证书

使用单个 SSL 客户端证书

--ssl-client-cert公共客户端证书文件的路径

--ssl-client-key私有客户端密钥的路径（可选）

--ssl-client-passphrase用于保护私有客户端密钥的密码（可选）

使用 SSL 客户端证书 配置文件（支持多个证书）

--ssl-client-cert-list

SSL 客户端证书列表配置文件的路径（JSON 格式）。示例如下ssl-client-cert-list.json

" alt="Apifox CLI 命令行运行 开始 命令选项 " referrerPolicy="no-referrer" />

此选项允许根据 URL 或主机名设置不同的 SSL 客户端证书。 此选项优先于--ssl-client-cert,--ssl-client-key和--ssl-client-passphrase选项。如果列表中的 URL 没有匹配项，这些选项将用作后备选项。