匯出資料

Apidog 支援將 API 匯出為各種標準格式，包括 OpenAPI Specification、HTML、Markdown、Apidog 和 Postman，以滿足不同的整合與文件需求。

如何匯出

導覽至匯出設定

前往左側邊欄中的 Settings -> Export Data。

選擇資料範圍

選擇匯出 All APIs，或選取特定的 Endpoints/Tags。

選擇格式並設定

選擇你想要的格式（例如 OpenAPI 3.0），並調整任何格式專屬設定。

支援的格式

格式	版本／備註
OpenAPI / Swagger	支援 `3.1`、`3.0` 和 `2.0`。可匯出為 `JSON` 或 `YAML`。包含對 Apidog Extension 欄位的支援。
HTML / Markdown	產生靜態文件。最適合離線分享。
Apidog	包含所有專案資料的原生格式。
Postman	匯出與 Postman 相容的集合。

若要使用 離線文件，你可以按一下「Open URL」，直接在瀏覽器中檢視原始資料。

進階匯出選項

1. 從 Sprint 分支匯出

若要從特定 Sprint 分支匯出資料：

使用左上角的分支選擇器切換到所需分支。

前往 Export Data。Apidog 會從目前分支匯出 所有資料。

注意：此程序會在記憶體中將 sprint 分支與主分支合併，以確保資料完整性（解析參照）。從 sprint 分支匯出時，你無法選取端點子集。

2. 自訂 OpenAPI 設定

若要進行進階 OpenAPI 匯出，你可以透過 Module Name > Overview > Export/Backup API Specification > Add 設定包含規則。

你可以選擇在匯出中包含 OperationId 欄位，這對產生程式碼用戶端很有用。進一步了解 OperationId。

FAQ

Q: 為什麼我的匯出中缺少某些 API？
A: 這通常是因為多個 API 共用完全相同的 Method 和 Path。OpenAPI 規格要求 Method+Path 組合必須唯一。Apidog 會在匯出期間強制執行此規則（尤其是 HTML/Markdown/OpenAPI 格式）。請讓你的端點保持唯一以解決此問題。進一步了解端點識別。

Q: 為什麼 Markdown/HTML 匯出中的 API 順序不同？
A: 底層的 Swagger/OpenAPI 規格通常不會強制嚴格排序。Markdown 和 HTML 匯出是根據此規格資料產生的，因此可能會與你在 Apidog 用戶端中看到的排序不同。

Q: 我可以匯出為 PDF 或 Word 嗎？
A: 不支援直接匯出。我們建議先匯出為 Markdown，然後使用 Typora 或 Pandoc 等工具，將 Markdown 檔案轉換為 PDF、Word 或其他格式。

Q: 驗證值會被匯出嗎？
A: 會。Apidog 會自動將 Auth 設定匯出到 OpenAPI/Swagger 檔案的 securitySchemes 區段。不需要手動步驟。

如何匯出#

支援的格式#

進階匯出選項#

1. 從 Sprint 分支匯出#

2. 自訂 OpenAPI 設定#

FAQ#

如何匯出

支援的格式

進階匯出選項

1. 從 Sprint 分支匯出

2. 自訂 OpenAPI 設定

FAQ