安装和运行 Apidog CLI

Apidog CLI 旨在通过命令行运行 Apidog 测试场景。要开始使用 Apidog CLI，请先安装 Node.js，然后安装 Apidog CLI。之后你就可以运行测试场景了。

前提条件

系统中已安装 Node.js v16 或更高版本

已安装 npm（Node Package Manager）

拥有已创建测试场景的 Apidog 账户

安装 Apidog CLI

Apidog CLI 基于 Node.js 构建。要运行 Apidog CLI，请在使用前先安装 Node.js。

Apidog CLI 依赖 Node.js v16 或更高版本。

通过 npm 在系统中全局安装 Apidog CLI，这样你就可以在任何位置运行它：

以下是一些用于验证 Apidog CLI 是否成功安装的命令。

如果安装成功，执行上述命令后将直接打印版本号和安装路径。

更新 Apidog CLI

使用以下命令升级 Apidog CLI。

运行 Apidog CLI

要使用 Apidog CLI 运行测试场景，你首先需要创建并编排一个测试场景。然后，你可以像在可视化界面中运行一样，使用 Apidog CLI 从命令行运行该测试场景，并获取测试报告。

Apidog CLI 支持两种运行方式：

使用在线数据运行：适用于实时场景。

使用导出的测试场景运行：适用于离线场景。

实时运行在线数据

在测试场景中，切换到 CI/CD 选项卡。

配置环境、测试数据、迭代次数、延迟等。

在 CI/CD 提供方部分，选择“Command line”。

点击“Add access token”按钮，然后点击“Generate token”。

了解更多关于 access token 的信息。

点击命令以复制它。

将命令粘贴到命令行中并运行。你将在命令行中获得一份测试报告。

在步骤 2 中，你设置的配置将自动决定 CLI 中使用的选项和值：

环境：映射到 -e <environmentId>。

测试数据：映射到 -d <testDataId>。

迭代次数：映射到 -n <n>。

延迟：映射到 --delay-request <n>。

环境/全局变量：如果选择 Export current value and use it，你可以在下方找到导出选项，用于将项目中的环境/全局变量当前值导出到文件。这会影响 --variables <path>。你需要将此文件导入到运行 CLI 的机器上，并通过 --variables <path> 指定其路径。在此了解更多关于“Use initial value”和“Export current value and use it”之间差异的信息。

如果你的测试场景还使用了本地存储的数据库连接配置，产品界面会引导你将这些配置导出到本地文件，这会影响 --database-connection <path>。随后你需要将该导出的文件导入到运行 CLI 的机器上，并在 --database-connection <path> 中指定其路径。

运行导出的数据

此选项允许你使用导出的文件在本地运行离线测试。

在测试场景中，切换到 CI/CD 选项卡。

配置环境、测试数据、迭代次数、延迟等。

在 CI/CD 提供方中，选择“Command line”，然后切换到“Run exported data”。

将测试场景导出为 JSON 文件。

复制下方显示的命令。

将命令粘贴到命令行中并运行。你将获得一份命令行测试报告。

步骤 2 中的设置（例如“Run Online Data”）将自动影响下面 CLI 中使用的选项和值。请注意，以这种方式运行时，环境/全局变量会使用随测试场景一起导出的文件中的值。在此了解更多信息。

CLI 测试报告

运行 CLI 后，你将收到一份命令行测试报告，其中包含测试场景的执行统计信息，以及失败请求的校验和断言。

你还可以在运行 CLI 的文件夹中找到 /apidog-reports/ 目录。该目录包含 HTML 格式的 CLI 测试报告。

选项

Apidog CLI 提供了丰富的选项，用于自定义集合运行。请在 Apidog CLI Options 了解更多信息。

将 Apidog CLI 与 CI/CD 结合使用

Apidog CLI 支持与各种流水线工具集成，例如 Jenkins、GitLab、GitHub Actions 等。了解更多关于集成 CI/CD的信息。

安装和运行 Apidog CLI

前提条件#

安装 Apidog CLI#

更新 Apidog CLI#

运行 Apidog CLI#

实时运行在线数据#

运行导出的数据#

CLI 测试报告#

选项#

将 Apidog CLI 与 CI/CD 结合使用#

前提条件

安装 Apidog CLI

更新 Apidog CLI

运行 Apidog CLI

实时运行在线数据

运行导出的数据

CLI 测试报告

选项

将 Apidog CLI 与 CI/CD 结合使用