本文介紹 Apidog 的核心概念。Apidog 是一款 API-first 工具,專為高效率的 API 設計、測試與協作而打造。許多概念與 Postman 等類似產品不同。理解這些概念將有助於你有效掌握 Apidog 的工作流程。Apidog 中的 Project 是協作的主要單位,包含模組、環境、測試場景等內容。它作為團隊內所有 API 相關工作的容器。專案的主要組成#
環境:用於不同部署階段的變數集合(例如:開發、預備、生產)。
端點規格:基於 OpenAPI/Swagger 標準的 API 文件。
與 Postman 的比較#
| Apidog 概念 | Postman 中的對應項 | 說明 |
|---|
| Project | Workspace | 用於協作的頂層組織單位。 |
| Module | Collection Folder | 將相關端點分組。 |
| Team | Team | 共享存取與協作功能。 |
專案支援無縫協作,讓多位使用者能同時處理 API,同時維持版本控制與存取權限。
模組 會在專案內以邏輯方式組織端點,類似微服務架構中的「服務」。每個模組代表一個獨立的 OpenAPI 規格檔案。模組的功能#
可依每個環境設定 Base URL,以便自動產生 URL。
何時使用模組#
預設:新專案會從一個模組開始;若需要多個 Base URL,可視需要新增更多模組。
模組與 OpenAPI Specification (OAS) 對齊,有助於與其他工具整合並維持清晰的 API 邊界。
Endpoint 是 Apidog API-first 方法中的核心元素,代表特定的 API 操作(例如 GET /users/{id})。端點管理#
與 Postman 的差異#
| 面向 | Apidog(以端點為基礎) | Postman(以請求為基礎) |
|---|
| 基本單位 | 端點(API 規格) | 請求(單次呼叫) |
| 規格變更 | 自動更新案例與測試 | 需要手動重寫 |
| 結構 | 帶有除錯功能的 OAS 擴充 | 規格與請求分離 |
在 Apidog 中,端點規格的變更會自動傳播到所有相依案例,透過這種規格驅動的方法降低維護成本。
環境 會管理不同部署情境的變數與 Base URL,讓你能在開發、預備與生產之間無縫切換。主要功能#
自動建構 URL:Base URL + 端點路徑。
Base URL 範例#
| 服務 | Base URL(Prod) | 端點路徑 | 完整 URL |
|---|
| User | https://user.example.com | GET /user/{id} | https://user.example.com/user/{id} |
| Order | https://order.example.com | GET /order/{id} | https://order.example.com/order/{id} |
| Product | https://product.example.com | GET /product/{id} | https://product.example.com/product/{id} |
不需要手動使用 {{BaseUrl}} 佔位符;Apidog 會偵測模組並自動套用正確的 Base URL。
Request 是獨立的 API 呼叫,不與端點規格綁定,類似 Postman 的請求。請求能力#
請求為 API 規格未預 先定義的情境提供彈性,銜接設計優先與請求優先工作流程之間的落差。
測試場景#
Test Scenario 會執行批次請求,類似 Postman Collections,並具備進階自動化功能。進階能力#
測試場景會隨 API 規格變更自動同步,確保測試在 API 演進時仍保持有效。
Design-first Mode 與 Request-first Mode#
Apidog 的 APIs 模組提供兩種模式,可在介面左下角切換:Design-first Mode 與 Request-first Mode。兩種模式提供相似的功能,但介面不同,以滿足不同團隊的工作流程。Design-first Mode#
Request-first Mode#
理解這些核心概念將幫助你運用 Apidog 的 API-first 方法進行高效率的設計、測試與協作。從建立專案開始,將端點組織到模組中,為不同階段定義環境,並建立測試場景以進行自動化。如需進一步閱讀,請瀏覽已連結的文件頁面,或試用 Apidog 介面以實際了解這些概念。
準備好開始了嗎?#