APl 設計指南 - Apidog Docs

需要 Apidog 版本 2.7.22或更新版本。

Apidog 強烈建議所有 API 文件都應依照 OpenAPI (Swagger) Specification 進行設計。你可以參考這篇文章，了解為什麼遵循此規範對你的 API 很重要。

Apidog 的許多其他功能，例如由 AI 驅動的端點合規性檢查、AI 命名等，都仰賴完整且定義明確的 API 設計指南。透過標準化的指南：

Apidog 的其他功能能更有效地運作

你的團隊能保持一致，並遵循一致的設計原則

在 Apidog 中，你可以透過點擊資料夾樹上方的「+」>「New APl design guidelines」來建立新的 API 設計指南。

建立新的 API 設計指南時，你會有兩個選項：

範例範本（建議）
使用 Apidog 提供的完整 API 設計指南範本。在大多數情況下，這是建議的選擇。此範本以 OAS（OpenAPI Specification）為基礎，並參考 Microsoft 的 API 設計最佳實務編製而成。

空白範本
建立空白的設計範本。此選項僅提供規範的基本結構，不包含詳細內容。接著你可以撰寫團隊自己的 API 設計指南。如果你的團隊已經建立了標準和最佳實務，這可能會是更好的起點。

在選擇、預覽並確認符合你需求的範本後，系統會在你的專案中建立新的 API 設計指南。你可以依需求完整自訂其內容。設計指南會顯示在資料夾樹的頂部，以提醒所有團隊成員規範的重要性。