通过 CLI 运行测试套件

选择合适的运行方法

Apidog 提供多种运行测试套件的方式，适用于不同的测试需求。

本地可视化执行：

此方法从本地机器发起，适用于小规模、快速测试。

当开发和测试同时进行时尤其有效，可进行实时监控并立即调整。

本地 Apidog CLI 执行：

此方法非常适合处理大规模数据或迭代场景，可提供更快的执行速度。

它支持离线运行，适用于资源受限或不需要图形用户界面的环境。

CI/CD 执行：

这种执行方式集成在 CI/CD 流水线中，是自动化集成和持续部署流程的理想选择。

在每次代码更新后需要频繁运行测试以确认 API 稳定性的场景中尤其有用。

自托管 Runner 执行：

团队可以在自己的服务器上设置 Apidog Runner，利用更强大的计算资源进行测试。

此方法支持定时任务，非常适合需要定期测试或测试需求较大的场景。

TIP

在测试套件中，如果使用了环境/全局变量，这些变量的实际值可能会因所选择的执行方法而不同，从而可能导致测试结果不一致。了解更多。

运行 Apidog CLI

要使用 Apidog CLI 运行测试套件，首先需要创建并编排一个测试套件。然后，你可以使用 Apidog CLI 从命令行运行该测试套件，并获取测试结果和测试报告。

在测试套件中，切换到 CI/CD 标签页。

配置运行环境和通知方式等参数。界面中的每项配置都会实时反映在下方生成的 CLI 命令中。

在 CI/CD 提供方部分，选择 CLI 命令行或其他平台。

点击“添加访问令牌”按钮，然后点击“生成令牌”，用于 CLI 调用认证。了解更多。

点击复制命令，将其粘贴到命令行并执行，即可查看测试执行过程和测试报告。

注意：要成功运行该命令，你需要先安装 Apidog CLI。如果已经安装，则需要将其更新到最新版本。

关于变量和本地配置文件（可选）

在某些场景中，CLI 执行需要本地配置文件：

环境/全局变量

如果选择“导出当前值以供使用”，你需要将导出的变量文件放置在 CLI 执行机器上，并通过 --variables <path> 指定文件路径。

关于“使用初始值”和“导出当前值以供使用”的区别，请参阅：跨不同运行方法使用环境/全局变量的规则。

数据库连接

如果测试使用了本地保存的“数据库连接”，界面将引导你导出配置文件，并在 CLI 中通过 --database-connection <path> 使用该文件。

建议以变量形式保存“数据库连接”详细信息，这样在运行 CLI 时无需额外使用 --database-connection <path>，同时也更便于协作和维护。了解更多。

CLI 测试报告

运行 CLI 后，你将获得一份命令行测试报告，其中包含测试套件的执行统计信息，以及失败请求的验证和断言信息。

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

命令选项

Apidog CLI 提供丰富的配置选项，用于自定义测试套件的执行。有关详细信息，请参阅 CLI 命令选项。

在 CI/CD 中使用 Apidog CLI

Apidog CLI 支持与 Jenkins、GitLab、GitHub Actions 等各种流水线工具集成。要了解更多信息，请参阅 CI/CD 集成。

通过 CLI 运行测试套件

选择合适的运行方法#

运行 Apidog CLI#

关于变量和本地配置文件（可选）#

CLI 测试报告#

命令选项#

在 CI/CD 中使用 Apidog CLI#

选择合适的运行方法

运行 Apidog CLI

关于变量和本地配置文件（可选）

CLI 测试报告

命令选项

在 CI/CD 中使用 Apidog CLI