概述 - Apidog Docs

Apidog 提供強大的發布功能，可將你的 API 規格轉換為專業、互動式文件。無論你需要在團隊內部分享 API，或公開發布完整文件，Apidog 都提供彈性選項來滿足你的需求——從快速分享連結到使用自有網域的完全自訂文件網站皆可支援。

分享你的 API 文件

Apidog 提供多種分享與發布 API 文件的方式，每種方式都針對不同使用情境而設計：

快速分享：從你定義的 API 規格一鍵產生美觀的 API 文件，非常適合快速協作

互動式文件：啟用「Try it out」功能與線上程式碼產生，方便動手探索 API

文件網站：發布完整的文件網站，結合 Markdown 內容與 API 文件，打造完整的使用者指南

自訂導覽：自訂文件的導覽列，以改善使用者體驗

自訂網域：將文件綁定至你自己的網域，建立專業品牌形象

自訂 URL：定義自訂頁面 URL 結構

資料夾自訂：自訂文件中的資料夾樣式與點擊行為

多版本發布：同時發布與管理多個 API 版本

文件範例

查看已發布文件的真實範例：https://docs.salla.dev/

Apidog 提供完整支援，幾乎可為任何 API 技術建立文件。無論你使用的是傳統 REST API、現代 GraphQL、即時 WebSocket 連線，或企業級 SOAP 服務，Apidog 都能滿足你的需求。

支援的技術包括：REST、SOAP、GraphQL、gRPC、WebSocket、SSE 等。

探索我們的文件最佳實務與真實世界 API 範例合集，了解不同 API 類型如何被有效地記錄成文件。

了解更多

在支援的 API 技術中探索各種 API 技術的詳細指南與範例。

Apidog 提供兩種不同的發布方法，每種方法都針對不同情境最佳化。了解它們的差異將有助於你選擇最符合需求的方式。

快速分享 專為快速、彈性協作而設計——非常適合在開發期間與團隊成員或外部合作夥伴分享特定 API。發布文件 則用於建立專業、面向公開使用者的文件網站，並具備完整自訂能力。

建議

使用 快速分享 進行內部協作與快速 API 審閱。當你需要面向公開使用者的專業品牌化文件網站時，請使用 發布文件。