與 Github Actions 整合

Apidog 支援透過簡單的 CLI 命令，在任何 CI/CD 流程中執行自動化測試。無論你使用的是 GitHub Actions、GitLab CI、Jenkins，還是自訂的 webhook 處理器，都可以在 Git 儲存庫更新時自動觸發 Apidog 測試。

先決條件

GitHub 帳號與儲存庫

已建立測試情境的 Apidog 帳號

產生 Apidog access tokens 的權限

運作方式

此整合基於一個簡單原則：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" 分頁。

如果這是你第一次在該 repo 中設定 Actions，請點擊 "New workflow" 建立一個新的 workflow。

步驟 2：在 Apidog 中產生 GitHub Actions 設定

在 Apidog 中，開啟你的專案並前往 "Tests" 頁面。

切換到 "CI/CD" 分頁。

設定測試環境、決定是否啟用測試資料，並設定迴圈次數與延遲間隔。

選擇 "GitHub Actions"，然後點擊 "Copy"。

步驟 3：在 GitHub 中貼上並提交 Workflow

返回你的 GitHub 儲存庫並開啟 Actions 頁面。

建立新的 workflow，並貼上從 Apidog 複製的設定程式碼。

如果你已經有現有的 CI pipeline，可以將 Apidog 測試設定合併進去。

點擊 "Commit changes" 以儲存並啟用 workflow。

請務必將程式碼中的變數 $APIDOG_ACCESS_TOKEN 替換為你實際的 Access Token。

workflow 檔案會儲存在你儲存庫的 .github/workflows/ 之下。
它是你原始碼的一部分，當你在本機 clone 或 pull 專案時也會一併包含。你可以在本機開發環境中編輯它，並像其他檔案一樣透過 Git 提交變更。

workflow 檔案頂部包含類似以下的一行：

這會告訴 GitHub，只要有人 push 程式碼或開啟／更新 pull request，就自動觸發 workflow。這是一種簡寫語法，等同於更詳細的版本，且非常適合大多數 CI 情境。

如果你想自訂哪些分支或事件應觸發 workflow，可以參考官方文件：
👉 GitHub Actions：觸發 workflow 的事件

步驟 4：執行 Workflow 並查看結果

設定完成後，每當有新的程式碼提交時，GitHub Actions workflow 會自動執行。你可以在 Actions 頁面上監控 workflow 狀態與測試結果。

與 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 並查看結果