API Academy
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Testing APIs
  • 歡迎
  • 目錄
  • API 學院
    • Get Started
      • 什麼是 API?
      • API 如何運作?
      • 如何呼叫 API?
      • 如何閱讀 API 文件?
      • 章節總結
    • API Fundamentals
      • API 基礎知識:概覽
      • 方法與路徑
      • 參數
      • 請求 Body
      • 回應
      • API 規格與 OAS
      • 章節總結
    • Working with APIs
      • 使用 API:概覽
      • 根據規格發送請求
      • 環境與變數
      • 串聯多個端點
      • 處理 Auth
      • 處理 API 簽名
      • 腳本介紹
      • 章節總結
    • Mocking APIs
      • Mocking API:概覽
      • Smart Mock
      • Mock 預期結果
      • Cloud Mock
      • Mock 腳本
      • 章節總結
    • Designing APIs
      • 設計 API:概覽
      • API 設計介紹
      • 建立您的第一個 API 專案
      • 分析需求並規劃您的 API
      • 設計資料模型
      • 設計端點
      • 使用組件與可重用性
      • 設定與 Auth
      • API 設計指南
      • 章節總結
    • Developing APIs
      • 開發 API:概覽
      • 設定:安裝您的 AI 程式碼助手
      • 快速入門:30 分鐘內從規格到運行的 API
      • 了解生成的程式碼
      • 使用 Apidog 測試您的 API
      • 部署:將您的 API 上線
      • 章節總結
    • Testing APIs
      • 測試 API:概覽
      • 快速入門:您的第一個測試場景
      • 整合測試與資料傳遞
      • 動態值
      • 斷言與驗證
      • 流程控制:If, For, ForEach
      • 資料驅動測試
      • 性能測試
      • 測試報告與分析
      • CI/CD 整合
      • 排程任務與自動化
      • 進階測試策略
      • 章節總結
    • API Documentations
      • API 文件:概覽
      • 發布您的第一個 API 文件
      • 自訂文件外觀
      • 給消費者的互動功能
      • 進階發布設定
      • 管理 API 版本
      • 章節總結
    • Advanced API Technologies
      • 進階 API 技術:概覽
      • GraphQL
      • gRPC
      • WebSocket
      • Socket.IO
      • Server-Sent Events
      • SOAP
      • 章節總結
    • API Lifecycle
      • API 生命周期:概覽
      • API 生命周期的階段
      • API 治理
      • API 安全最佳實踐
      • 監控與分析
      • API 版本策略
      • API 的未來
      • 章節總結
    • API Security
      • API 安全性:概覽
      • API 安全性基礎知識
      • 身份驗證 vs. 授權
      • 了解 OAuth 2.0 和 OpenID Connect
      • JSON Web Tokens (JWT)
      • OWASP API 安全 Top 10
      • 加密與 HTTPS
      • 章節總結
    • API Tools
      • API 工具:概覽
      • API 工具的演變
      • API Clients
      • 命令列工具 (cURL, HTTPie)
      • API 設計和文件工具
      • API Mocking 工具
      • API 測試工具
      • 一體化 API 平台
      • 章節總結
    • API Gateway
      • API Gateway:概覽
      • 什麼是 API Gateway?
      • API Gateway 的關鍵功能
      • API Gateway vs 負載平衡器 vs 服務網格
      • 流行 API Gateway 解決方案
      • BFF (Backend for Frontend) 模式
      • 章節總結
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Testing APIs

CI/CD 整合

在現代 DevOps 世界中,如果它不是自動化的,它就不存在。您不想每次開發人員推送程式碼時都手動點擊「運行」。您希望您的測試自動運行,阻止糟糕的程式碼進入生產環境。
Apidog 透過 Apidog CLI 與 Jenkins、GitHub Actions、GitLab CI 等無縫整合。

核心:Apidog CLI#

Apidog CLI 是一個命令列工具,允許您在任何環境(Linux 伺服器、Docker 容器或 Jenkins 代理)中運行從 Apidog 匯出的測試場景(或直接從雲端運行)。
查看詳情:Apidog CLI

1. 安裝 Apidog CLI#

它是一個 npm 套件,所以它可以在任何運行 Node.js 的地方運行。

基本用法#

要運行測試場景,您只需要它的 ID(在測試內容的 CI/CD 分頁中找到)。

與 GitHub Actions 整合#

這是開源和現代團隊最常見的設置。

步驟 1:獲取您的 Token 和 ID#

1.
在 Apidog 中,前往 Test Scenario -> CI/CD。
2.
複製您的 APIDOG_ACCESS_TOKEN(保密!)。
3.
複製包含 SCENARIO_ID 的執行命令。

步驟 2:建立工作流程檔案#

在您的 Repo 中建立 .github/workflows/api-test.yml:
現在,每當有人推送程式碼時,GitHub 都會分配一台伺服器,安裝 Apidog CLI,運行您的完整回歸套件,並將通過/失敗報告回 Pull Request。

與 Jenkins / GitLab CI 整合#

對於其他 CI 提供商,原理保持不變。無論您是使用 Jenkins(透過 Groovy 管道中的 sh 'npm install ...' 步驟)還是 GitLab CI(由 .gitlab-ci.yml 中的 job 新增),核心要求是相同的:
只要 Runner 機器有網際網路存取權限並能連接您的 API,Apidog CLI 就可以工作。

在 Localhost 運行#

CI 中的常見挑戰是 API 尚未部署——它在 CI 機器的 localhost 上運行。
Apidog CLI 自然地處理這個問題,因為它直接在 CI 機器上運行。您只需構建管道以先啟動您的 API(例如 npm start &),等待連接埠打開,然後針對 http://localhost:8000 執行 Apidog CLI 命令。

關鍵重點#

將 API 測試整合到 CI/CD 管道中
使用 Apidog CLI 進行自動化
確保持續的反饋迴圈

下一步#

CI/CD 處理程式碼更改。但是如果 API 在沒人更改程式碼時當機怎麼辦?我們需要 監控 (Monitoring)。
在下一章中,我們將設定 排程任務 (Scheduled Tasks) 以 24/7 監視您的 API。
繼續閱讀 → 排程任務和自動化
Modified at 2025-12-29 09:35:19
Previous
測試報告與分析
Next
排程任務與自動化
Built with