有效的 API 協作需要無縫的文件分享。快速分享透過提供即時的線上文件連結,消除了來回傳遞 Word 或 PDF 檔案的低效率。此功能可讓團隊之間快速溝通,讓你能與協作者分享特定 API 端點,同時維持對存取權限、可見性與到期時間的控制。先決條件#
建立快速分享#
切換到左側邊欄的 Publish Docs 模組。點擊 +New 建立新的快速分享。一個專案支援多個快速分享,可分發給不同的協作者。所有團隊成員都可以查看團隊中任何人建立的快速分享。設定選項#
Title:此分享的名稱,僅在 Apidog 團隊內可見,用於內部識別,不會顯示在分享的文件中。
Environments:選擇線上文件中可用的環境。預設不會選取任何環境。你可以選取多個環境。所選環境會在文件中對讀者可見,並可在使用「Try it out」時用於傳送請求。
如果你在建立文件時選取 Cloud mock 環境,即表示你為讀者提供了一個簡單的沙盒環境,用於測試 API,而不會影響正式系統。
Document content:文件有兩個選用元件:Base URL 和 Request samples。你可以選擇是否在文件中顯示它們。Base URL:這是環境中設定的基底 URL。如果選取,每個介面在文件中都會顯示完整 URL;如果未選取,文件中的 URL 會以「/」開頭。
在端點描述上方顯示「Last Modified」時間。
在文件結尾顯示「Last Modified」時間。
Allow 'Export', 'Clone' Data:是否允許讀者以 OAS/Markdown/HTML/Apidog 格式匯出與複製資料。
Scope to share:選擇要包含在此分享中的 API 端點與 Markdown。你可以依目錄或篩選器選取,並依標籤排除。你也可以選擇分享整個資料夾。 Security:你可以設定存取此文 件是否需要密碼,以及此文件的到期時間。如果未選取到期時間,則永不過期。
Show API Fields:你可以設定這些欄位是否顯示在文件中。包含:Owners、Update time、OperationId、Original link、Authorization Required。
Language:此處的語言設定會影響文件中的功能性固定文字,例如「Query Params」「Request samples」等,但不會影響 API 文件內容中撰寫的文字。
CORS Proxy:你可以部署並設定 CORS 代理伺服器,以處理 API 文件上的端點請求。Learn more。 Advanced Settings:設定如隱藏「Try it out」按鈕與隱藏「Powered by Apidog」等選項。
請求範例#
建立分享時,你可以選擇是否顯示請求程式碼範例。
如何自訂請求範例:1.
在 Settings → Feature settings → Endpoint feature settings → Endpoint fields 中,啟用 Request samples 欄位
2.
在 Endpoint → Edit 中,Request samples 模組會出現在結尾
3.
點擊 Custom Request Code Samples,以你偏好的語言新增範例
分享整個資料夾#
快速分享支援 Share entire folder,非常適合分享後仍會持續新增或移除文件的情境。啟用後,協作者會自動存取該資料夾中的所有文件,而不需要你針對每份新文件調整分享設定。在 Scope to Share 區段中,選取 Manual Selection 即可看到 Share entire folder 選項。啟用後,協作者會自動存取該資料夾中的所有文件。CORS 代理設定#
與外部使用者分享 API 文件時,他們在瀏覽器中直接測試端點時,可能會遇到跨來源資源共用(CORS)問題。CORS 代理會透過指定的代理代理程式路由請求,繞過瀏覽器 CORS 限制,從而實現順暢的 API 測試。若要設定 CORS 代理,請在建立新的分享文件時點擊設定選項。預設情況下,Apidog 提供 Cloud Agent 來管理所有分享文件中的端點請求。CORS 代理選項#
Cloud Proxy:使用 Apidog 的 Cloud Agent 處理端點請求。注意:Cloud Agent 無法存取內部網路上的端點
Browser Extensions:使用安裝在使用者瀏覽器中的瀏覽器擴充功能。未安裝擴充功能的使用者在發出請求前,將會被提示安裝
No Proxy:請求會直接從使用者的瀏覽器送出。請確保你的端點伺服器已正確設定以處理 CORS