与 Github Actions 集成

Apidog 支持通过简单的 CLI 命令在任何 CI/CD 流水线中运行自动化测试。无论你使用的是 GitHub Actions、GitLab CI、Jenkins，还是自定义 webhook 处理程序，都可以在 Git 仓库更新时自动触发 Apidog 测试。

前提条件

一个 GitHub 账号和仓库

一个已创建测试场景的 Apidog 账号

具备生成 Apidog 访问令牌的权限

工作原理

该集成基于一个简单的原则：Git Webhook + CLI 执行。

当发生 Git 事件（例如 push 或 pull request）时，你的 CI/CD 工具会接收该事件，并运行 apidog run 命令来执行你的测试场景。

本指南以 GitHub Actions 为例——因为它被广泛使用，并且不需要额外的基础设施。但同样的方法也适用于其他平台。

此设置非常适合：

在每次 push 或 pull request 时自动运行 API 测试

监控特定分支（例如 main、develop）

支持部署前检查和回归测试

确保在 CI 工作流中一致地执行测试

现在让我们使用 GitHub Actions 逐步完成设置。

步骤 1：初始化 GitHub Workflow

前往 GitHub 并登录你的账号。

导航到你的目标仓库。

点击顶部导航栏中的 "Actions" 选项卡。

如果这是你第一次在该仓库中设置 Actions，请点击 "New workflow" 创建一个工作流。

步骤 2：在 Apidog 中生成 GitHub Actions 配置

在 Apidog 中打开你的项目，并进入 "Tests" 页面。

切换到 "CI/CD" 选项卡。

配置测试环境，决定是否启用测试数据，并设置循环次数和延迟间隔。

选择 "GitHub Actions"，然后点击 "Copy"。

步骤 3：在 GitHub 中粘贴并提交 Workflow

返回你的 GitHub 仓库并打开 Actions 页面。

创建一个新的工作流，并粘贴从 Apidog 复制的配置代码。

如果你已经有现有的 CI 流水线，可以将 Apidog 测试配置合并到其中。

点击 "Commit changes" 保存并启用该工作流。

请确保将代码中的变量 $APIDOG_ACCESS_TOKEN 替换为你的实际 Access Token。

工作流文件将保存在仓库的 .github/workflows/ 下。
它是源代码的一部分，并且在你克隆或拉取项目到本地时会被包含在内。你可以像编辑任何其他文件一样，在本地开发环境中编辑它，并通过 Git 提交更改。

工作流文件顶部包含类似如下的一行：

这会告诉 GitHub：每当有人推送代码或打开/更新 pull request 时，自动触发该工作流。它是一种简写语法，等同于更详细的写法，并且适用于大多数 CI 场景。

如果你想自定义哪些分支或事件应触发工作流，可以参考官方文档：
👉 GitHub Actions: Events that trigger workflows

步骤 4：运行 Workflow 并查看结果

配置完成后，每当有新的代码提交时，GitHub Actions 工作流都会自动运行。你可以在 Actions 页面监控工作流状态和测试结果。

与 Github Actions 集成

前提条件#

工作原理#

步骤 1：初始化 GitHub Workflow#

步骤 2：在 Apidog 中生成 GitHub Actions 配置#

步骤 3：在 GitHub 中粘贴并提交 Workflow#

步骤 4：运行 Workflow 并查看结果#

前提条件

工作原理

步骤 1：初始化 GitHub Workflow

步骤 2：在 Apidog 中生成 GitHub Actions 配置

步骤 3：在 GitHub 中粘贴并提交 Workflow

步骤 4：运行 Workflow 并查看结果