分享 API 文件

當你的 API 已開發完成並成功偵錯後，Apidog 可讓你輕鬆產生專業文件，並分享給你的團隊、利害關係人或外部開發者。

逐步指南

請依照以下步驟產生並分享你的 API 文件：

步驟 1：存取分享文件模組

1. 開啟你的 Apidog 專案

2. 從側邊欄切換至 Share Docs 模組

步驟 2：建立新的分享

1. 點擊 New 按鈕以開始新的文件分享
2. 這將開啟分享設定對話框

步驟 3：設定分享設定

在分享設定中完成以下設定：

設定	說明	建議操作
名稱	為你的分享提供具描述性的名稱	使用專案名稱 + 版本（例如："Pet Store API v1.2"）
環境	選擇要包含哪些環境	選取所有環境，以取得完整文件
存取權限	設定可見性權限	根據你的受眾選擇適當的存取層級


3. 點擊 Save 以建立你的分享

步驟 4：存取你的文件

1. 你的新分享將出現在分享清單中
2. 點擊 Open，在網頁瀏覽器中檢視你的文件
3. 文件將在新分頁中開啟，並提供可分享的 URL

步驟 5：探索文件功能

你的文件包含強大的功能：

• 互動式 API Explorer：在左側目錄樹中瀏覽端點

• Try It Out：直接從文件傳送即時請求

• 程式碼產生：產生請求程式碼片段和資料模型程式碼

• 環境切換：測試不同的 API 環境

進階自訂與發布

Apidog 為你的文件提供額外的自訂選項：

功能	說明	使用情境
自訂版面配置	修改文件結構和外觀	品牌一致性、使用者體驗最佳化
自訂網域	使用你自己的網域名稱	專業呈現、品牌識別
自訂 URL	建立易記且有意義的 URL	行銷、輕鬆分享、SEO 效益
存取控制	設定細緻的權限	內部團隊、外部合作夥伴、公開存取

---

進一步了解如何在 Apidog 中設計、測試、模擬和發布 API。