您已經花了數小時為 Pet Store 設計完美的 User 模組。它有清晰的資料結構、有意義的範例和錯誤回應。現在，您如何將這些提供給您的前端開發者或外部合作夥伴？Apidog 提供兩種主要方式來分享您的工作：快速分享和發布文件。了解它們之間的差異是建立正確工作流程的關鍵。快速分享 vs. 發布文件#
| 功能 | 快速分享 | 發布文件 |
|---|
| 目的 | 內部團隊協作、快速審閱 | 官方發布、開發者入口網站 |
| 持久性 | 臨時/即席 | 長期、品牌化網站 |
| 自訂 | 有限 | 完整（自訂網域、CSS、導覽） |
| 存取控制 | 密碼 / 到期 | 密碼、IP 白名單、SSO |
| SEO | 無 | 有 |
在本章中，我們專注於發布文件——為您的 API 建立一個永久、專業的家。
步驟 1：初始化您的文件網站#
1.
在您的 Apidog 專案中，在左側側邊欄尋找 Share Docs。
3.
您將看到為您建立 的預設「Main Site」。點擊 Publish 使其立即上線。
project-id.apidog.io）。您可以現在將此連結發送給任何人，他們將會看到您的 API 文件。步驟 2：控制存取#
並非所有 API 都是為了公開的。您可能只想與特定的合作夥伴或內部團隊分享您的 User 模組。點擊 「Docs Site Visibility」 來探索您的選項：Public (公開)#
任何擁有連結的人都可以查看。這對於開源專案或公開平台 API 非常棒。您甚至可以選擇發布到 Apidog API Hub 以獲得更高的可發現性。Password Protected (密 碼保護)#
Enterprise Controls (企業控制)#
IP 白名單：限制僅能透過您公司的 VPN 或辦公室 IP 範圍存取。
Email 白名單：只有詳細的電子郵件地址可以透過驗證碼存取。
自訂登入頁面：使用 JWT 與您自己的 SSO (單一登入) 整合。這允許使用者使用他們現有的公司憑證登入以查看文件。
步驟 3：設定內容範圍#
1.
在發布設定中，尋找 Content 或 Scope 部分。
2.
選擇要包含的資料夾。對於我們的範例，優先考慮我們之前組織的 User Management 資料夾。
重點摘要#
快速分享 vs. 發布文件：使用快速分享進行內部審閱；使用發布文件建立官方、持久的文件網站。
存取控制：使用密碼、IP 白名單或 SSO 保護您的文件，以保護敏感的 API 資訊。
內容範圍：您可以選擇性地發布特定資料夾或端點，保持內部草稿私密。
一鍵發布：Apidog 立即生成一個隨時可用的網站，省去您從頭開始建立入口網站的麻煩。
Modified at 2025-12-29 09:35:19
