Apidog Docs
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. 開始使用
  • Apidog 學習中心
  • 開始使用
    • Apidog 簡介
    • Apidog 中的基本概念
    • 導覽 Apidog
    • 快速開始
      • 概覽
      • 建立端點
      • 發送請求
      • 新增斷言
      • 建立測試情境
      • 分享 API 文件
      • 探索更多
    • 遷移到 Apidog
      • 概覽
      • 手動匯入
      • 排程匯入(綁定資料來源)
      • 匯入選項
      • 匯出資料
      • 匯入自
        • 從 Postman 匯入
        • 匯入 OpenAPI 規格
        • 匯入 cURL
        • 匯入 Markdown
        • 從 Insomnia 匯入
        • 從 apiDoc 匯入
        • 匯入 .har 檔案
        • 匯入 WSDL
  • Mock API 資料
    • 概述
    • Smart Mock
    • 自訂模擬
    • 模擬優先順序
    • 模擬腳本
    • 雲端模擬
    • 自託管 Runner 模擬
    • 模擬語言(Locales)
  • 帳號與偏好設定
    • 帳戶設定
    • 產生 OpenAPI 存取權杖
    • 通知
    • 語言設定
    • 快捷鍵
    • 網路代理設定
    • 備份資料
    • 更新 Apidog
    • 刪除帳戶
    • 實驗性功能
  • 傳送請求
    • 概覽
    • SSE 偵錯
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用請求代理代理程式進行偵錯
    • 建立請求
      • 請求歷史記錄
      • 請求基礎
      • 參數與主體
      • 請求標頭
      • 請求設定
      • 偵錯請求
      • 將請求儲存為端點
      • HTTP/2
    • 驗證與授權
      • 概覽
      • CA 和用戶端憑證
      • 授權類型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 驗證
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 回應和 Cookie
      • 檢視 API 回應
      • 管理 Cookie
      • 概覽
  • 開發和偵錯 API
    • 概觀
    • 產生請求
    • 傳送請求
    • 偵錯案例
    • 測試案例
    • 動態值
    • 驗證回應
    • Design-First 與 Request-First
    • 產生程式碼
    • 環境與變數
      • 概述
      • 使用變數
      • 環境管理
    • Vault 密鑰
      • 概覽
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 動態值模組
      • Airline
      • 動物
      • 顏色
      • Commerce
      • Company
      • 資料庫
      • Datatype
      • 日期
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • 圖片
      • Internet
      • 位置
      • Lorem
      • 音樂
      • Number
      • Person
      • Phone
      • 科學
      • 字串
      • System
      • Vehicle
      • Word
    • 前置和後置處理器
      • 概覽
      • 斷言
      • 擷取變數
      • Wait
      • 安全性
      • 資料庫操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • 使用腳本
        • 概觀
        • 前置處理器指令碼
        • 後置處理器腳本
        • 公開腳本
        • Postman Scripts Reference
        • 呼叫其他程式語言
        • 使用 JS Libraries
        • 視覺化回應
        • 腳本範例
          • 斷言腳本
          • 使用變數
          • 修改請求
          • 其他範例
    • API 偵錯
      • AI Agent Debugger
      • A2A Debugger
  • 設計 API
    • 概覽
    • 建立新的 API 專案
    • 端點基礎
    • APl 設計指南
    • 模組
    • 設定多個請求主體範例
    • 元件
    • 通用欄位
    • 全域參數
    • 端點變更歷史
    • 留言
    • 批次端點管理
    • 自訂協定 API
    • Spec-first 模式 (Beta)
    • 安全方案
      • 概觀
      • 建立安全性方案
      • 使用 Security Scheme
      • 線上文件中的安全性方案
    • 進階功能
      • 自訂端點欄位
      • 關聯的測試場景
      • 端點狀態
      • 參數列表的外觀
      • 端點唯一識別
    • Schemas
      • 概述
      • 建立新 Schema
      • 建立 Schema
      • 從 JSON 等產生 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • API 測試
    • 概述
    • 測試情境
      • 建立測試情境
      • 在請求之間傳遞資料
      • 流程控制條件
      • 從端點和端點案例同步資料
      • 從其他專案匯入端點和端點案例
      • 匯出測試情境
    • 測試報告
      • 測試報告
    • 執行測試情境
      • 執行測試場景
      • 批次執行測試場景
      • 資料驅動測試
      • 共享測試資料
      • 排程任務
      • 管理來自其他專案的 API 執行環境
    • 測試套件
      • 概述
      • 建立測試套件
      • 編排測試套件
      • 在本機執行測試套件
      • 透過 CLI 執行測試套件
      • 排程任務
    • 測試 API
      • 整合測試
      • 效能測試
      • 端對端測試
      • 迴歸測試
      • 契約測試
    • Apidog CLI
      • 概覽
      • 安裝並執行 Apidog CLI
      • Apidog CLI 選項
    • CI/CD
      • 概述
      • 與 Github Actions 整合
      • Integrate with Gitlab
      • 與 Jenkins 整合
      • 透過 Git Commit 觸發測試
  • 發布 API 文件
    • 概述
    • 支援的 API 技術
    • 快速分享
    • 檢視 API 文件
    • Markdown 文件
    • 發佈文件網站
    • 自訂登入頁面
    • 自訂版面配置
    • 自訂 CSS、JavaScript、HTML
    • 自訂網域
    • AI Features
    • SEO 設定
    • 進階設定
      • 文件搜尋
      • CORS Proxy
      • 整合 Google Analytics
      • 資料夾樹設定
      • 可見性設定
      • 在文件 URL 中嵌入值
    • API 版本
      • 概述
      • 建立 API 版本
      • 發佈 API 版本
      • 使用 API 版本分享端點
  • 分支
    • 概觀
    • 建立 Sprint 分支
    • 在分支中測試 API
    • 在分支中設計 API
    • 合併 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch (Beta)
  • AI 功能
    • 概觀
    • 啟用 AI 功能
    • 產生測試案例
    • 使用 AI 修改 Schema
    • 端點合規性檢查
    • API 文件完整性檢查
    • AI 驅動的欄位命名
    • 常見問題
  • Apidog MCP 伺服器
    • 概覽
    • 將 Apidog 專案連接至 AI
    • 將已發布的文件連接至 AI
    • 將 OpenAPI 檔案連接到 AI
  • Apidog Europe
    • Apidog Europe
  • 最佳實務
    • 處理 API 簽章
    • 存取受 OAuth 2.0 保護的 API
    • 協作工作流程
    • 管理驗證狀態
  • 離線空間
    • 概述
  • 管理
    • 管理專案
      • 管理專案
      • 通知設定
      • 管理專案成員
      • 專案資源
        • 資料庫連線
        • Git 連線
    • 管理團隊
      • 管理團隊
      • 管理團隊成員
      • 團隊活動
      • 團隊角色與權限
      • 團隊資源
        • General Runner
        • 團隊變數
        • 請求代理代理程式
      • 即時協作
        • 團隊協作
    • 入門檢查清單
      • 基本概念
      • 入門指南
    • 管理組織
      • 管理組織
      • 組織角色與權限
      • 方案管理
        • 組織中的帳單管理員
      • 單一登入 (SSO)
        • SSO 概覽
        • 設定 Microsoft Entra ID
        • 設定 Okta
        • 為組織設定 SSO
        • 管理使用者帳戶
        • 將群組對應到團隊
      • SCIM 佈建
        • SCIM 佈建簡介
        • Microsoft Entra ID
        • Okta
      • 組織資源
        • 自託管 Runner
  • 帳單
    • 概觀
    • 點數
    • 升級您的方案
    • 替代付款方式
    • 管理訂閱
    • 將付費團隊移至組織
  • 附加元件
    • API Hub
    • Apidog Intellij IDEA 外掛
    • 瀏覽器擴充功能
      • Chrome
      • Microsoft Edge
    • 請求代理
      • Web 中的請求代理
      • 共用文件中的請求代理
      • 用戶端中的請求代理
  • 資料與安全
    • 資料儲存與安全性
    • 使用者資料隱私與安全
    • 請求路由與資料安全
  • 參考
    • API 設計優先方法
    • Apidog OpenAPI 規格擴充
    • JSONPath
    • XPath
    • 正規表示式
    • JSON Schema
    • CSV 檔案格式
    • 安裝 Java 環境
    • Runner 部署環境
    • Apidog Markdown 語法
    • Apidog Swagger 擴充
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 擴充
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支援中心
  1. 開始使用

Apidog 中的基本概念

本文介紹 Apidog 的核心概念。Apidog 是一款 API-first 工具,專為高效率的 API 設計、測試與協作而打造。許多概念與 Postman 等類似產品不同。理解這些概念將有助於你有效掌握 Apidog 的工作流程。

專案#

Apidog 中的 Project 是協作的主要單位,包含模組、環境、測試場景等內容。它作為團隊內所有 API 相關工作的容器。

專案的主要組成#

模組:端點與相關元件的邏輯分組。
環境:用於不同部署階段的變數集合(例如:開發、預備、生產)。
測試場景:用於自動化測試的請求集合。
端點規格:基於 OpenAPI/Swagger 標準的 API 文件。

與 Postman 的比較#

Apidog 概念Postman 中的對應項說明
ProjectWorkspace用於協作的頂層組織單位。
ModuleCollection Folder將相關端點分組。
TeamTeam共享存取與協作功能。
專案支援無縫協作,讓多位使用者能同時處理 API,同時維持版本控制與存取權限。

模組#

模組 會在專案內以邏輯方式組織端點,類似微服務架構中的「服務」。每個模組代表一個獨立的 OpenAPI 規格檔案。

模組的功能#

包含相關的端點、結構描述、回應與安全性方案。
可依每個環境設定 Base URL,以便自動產生 URL。
支援模組層級的匯入/匯出操作,以更好地符合標準。

何時使用模組#

用於微服務:每個服務作為一個獨立模組。
用於多個 API:依功能或領域將端點分組。
預設:新專案會從一個模組開始;若需要多個 Base URL,可視需要新增更多模組。
模組與 OpenAPI Specification (OAS) 對齊,有助於與其他工具整合並維持清晰的 API 邊界。

端點#

Endpoint 是 Apidog API-first 方法中的核心元素,代表特定的 API 操作(例如 GET /users/{id})。

端點管理#

以目錄結構分組以便組織。
支援定義編輯、預覽、傳送請求,以及另存為端點案例。
連結至 端點案例,用於已儲存的請求範例。

與 Postman 的差異#

面向Apidog(以端點為基礎)Postman(以請求為基礎)
基本單位端點(API 規格)請求(單次呼叫)
規格變更自動更新案例與測試需要手動重寫
結構帶有除錯功能的 OAS 擴充規格與請求分離
在 Apidog 中,端點規格的變更會自動傳播到所有相依案例,透過這種規格驅動的方法降低維護成本。

環境#

環境 會管理不同部署情境的變數與 Base URL,讓你能在開發、預備與生產之間無縫切換。

主要功能#

包含用於動態值的環境變數。
支援每個環境使用多個 Base URL,適用於微服務。
自動建構 URL:Base URL + 端點路徑。
環境設定

Base URL 範例#

假設一個專案包含三個服務:
服務Base URL(Prod)端點路徑完整 URL
Userhttps://user.example.comGET /user/{id}https://user.example.com/user/{id}
Orderhttps://order.example.comGET /order/{id}https://order.example.com/order/{id}
Producthttps://product.example.comGET /product/{id}https://product.example.com/product/{id}
URL 產生
不需要手動使用 {{BaseUrl}} 佔位符;Apidog 會偵測模組並自動套用正確的 Base URL。

請求#

Request 是獨立的 API 呼叫,不與端點規格綁定,類似 Postman 的請求。

請求能力#

可獨立於規格進行建立。
可將成功的請求解析為端點規格。
用於臨時測試或未記錄文件的 API。
請求為 API 規格未預先定義的情境提供彈性,銜接設計優先與請求優先工作流程之間的落差。

測試場景#

Test Scenario 會執行批次請求,類似 Postman Collections,並具備進階自動化功能。

功能#

來自端點規格或案例的一系列請求,可在 API 規格變更時自動同步。
邏輯元件:If、For、ForEach。
在請求之間傳遞資料。
動態參數產生。

進階能力#

測試報告與效能測試。
資料驅動測試。
CI/CD 整合。
測試場景會隨 API 規格變更自動同步,確保測試在 API 演進時仍保持有效。

Design-first Mode 與 Request-first Mode#

Apidog 的 APIs 模組提供兩種模式,可在介面左下角切換:Design-first Mode 與 Request-first Mode。
兩種模式提供相似的功能,但介面不同,以滿足不同團隊的工作流程。

Design-first Mode#

建議 採用 API 設計優先實務的團隊使用。
在開發與測試之前定義 API 規格。
適合已規劃、以規格驅動的專案。

Request-first Mode#

適合優先專注於後端開發的團隊。
建立請求,然後從成功的呼叫產生規格。
非常適合未記錄文件的 API 或第三方整合。
深入了解 Design-first Mode 與 Request-first Mode。

摘要#

理解這些核心概念將幫助你運用 Apidog 的 API-first 方法進行高效率的設計、測試與協作。從建立專案開始,將端點組織到模組中,為不同階段定義環境,並建立測試場景以進行自動化。
如需進一步閱讀,請瀏覽已連結的文件頁面,或試用 Apidog 介面以實際了解這些概念。

準備好開始了嗎?#

從零開始
從零開始使用 Apidog
或
遷移到 Apidog
從遷移到 Apidog 開始
Modified at 2026-06-11 10:26:02
Previous
Apidog 簡介
Next
導覽 Apidog
Built with