模組 - Apidog Docs

在 Apidog 專案中，你可以使用模組來組織你的端點。模組類似於技術架構中的「服務」，旨在幫助你更有效率地管理與呈現端點——尤其是在以微服務為基礎的系統中。每個模組都包含自己的一組相關端點、元件（例如 schema、回應和安全性方案），以及 Base URL（每個環境各一個）。

每個模組都對應到一個完整且獨立的 Swagger/OpenAPI 規格檔案。

何時使用模組

在以下情況下，使用模組來組織你的端點：

緊密相關的服務：例如，在 AI 專案中：一個模組用於文字生成端點，另一個用於圖片生成端點，還有一個用於語音端點。

微服務：例如，在電子商務專案中，你可能會有驗證、訂單和產品服務。

多個 API 版本：例如，你的專案向外部使用者公開不同的 API 版本，例如 Legacy、LTS 和 Latest。

在專案中，將滑鼠懸停在資料夾樹的頂部，然後點擊 + 按鈕。在下拉式選單中，選擇 New Module。

輸入模組名稱並點擊 Save。新模組將出現在資料夾樹中。點擊該模組以查看其詳細資訊，包括：

模組中資源的資料統計

端點案例與測試情境的涵蓋率

模組中端點的匯出選項

資料來源設定

模組變數——類似於環境變數，但只能在此模組的端點請求中存取。

建立模組後，它會自動出現在環境管理頁面中。你可以在新加入的模組內，為每個環境指定一個 Base URL。

預設情況下，每個模組的端點請求都會自動使用目前環境中為該模組定義的 Base URL，並與端點路徑組合使用。某個模組中的端點無法使用另一個模組的 Base URL 來發送請求。

舊版使用模式

如果單一模組包含多個服務（多個 Base URL），你可以在模組內的資料夾或端點層級，手動指定要使用哪個 Base URL。

然而，這種做法是 Apidog 較舊使用模式的一部分，自版本 2.7.16 起不建議使用。相反地，我們建議將服務拆分到不同模組中，每個模組都有自己的 Base URL。