給消費者的互動功能

靜態文件已成為過去式。現代開發者期望在編寫一行程式碼之前，直接在瀏覽器中測試 API。Apidog 發布的文件附帶了一個嵌入式的 API 用戶端——**「Try it out」**功能。

這種互動性大大降低了使用者的「首次呼叫時間」(TTFC)。

「Try it out」控制台

當您發布文件時，每個端點頁面都包含一個 Run 或 Try it out 按鈕（除非已停用）。

當使用者點擊此按鈕時：

一個 API 用戶端面板會滑出。

他們可以填寫參數（例如 userId）。

他們可以修改請求 Body（使用您生成的範例！）。

他們點擊 Send 並看到來自伺服器（或 Mock 伺服器）的真實回應。

管理環境

使用者需要一個伺服器來進行通訊。

Mock 伺服器：預設情況下，Apidog 提供一個 Cloud Mock 伺服器。這允許使用者在不觸及生產資料庫的情況下獲得罐頭回應。理想情況下，為公開文件啟用此功能，以便使用者可以安全地進行操作。

生產/Staging：您可以設定多個環境。使用者可以在文件中從下拉選單選擇「Production」來進行真實呼叫。

提示：在公開文件中暴露生產環境時要小心。確保您已設定適當的 Auth（我們在 設計 APIs 中涵蓋了這一點）。

請求程式碼生成

並非每個開發者都知道如何用 curl 或 Python 建構 HTTP 請求。Apidog透過自動生成程式碼片段來幫助他們。

在您發布的文件中，使用者將看到 Request Samples 部分。他們可以在語言之間切換：

JavaScript (Fetch, Axios)

Python (Requests)

Java (OkHttp)

cURL

還有更多。

這允許開發者簡單地複製貼上一個可運作的程式碼區塊到他們的應用程式中。

自訂範例

如果自動生成的範例不夠（例如，如果您有特定的 SDK），您可以新增自己的手動程式碼範例。

前往端點設計。

捲動到 Request Samples。

新增自訂片段。

互動式回應範例

還記得我們設計的資料結構嗎？在文件中，它們被渲染為互動式樹狀結構。

使用者可以展開/摺疊物件。

他們可以查看每個欄位的描述和資料類型。

他們可以在不同的 Response Examples（例如 "Success - 200" vs "Error - 400"）之間切換，以查看 JSON 在不同場景下的樣子。

重點摘要

「Try it out」控制台：允許使用者直接從瀏覽器進行真實的 API 呼叫，立即將讀者轉化為使用者。

請求程式碼生成：自動生成多種語言（Python, JavaScript, cURL 等）的程式碼片段，幫助開發者更快整合。

互動式資料結構：使用者可以互動式地探索巢狀 JSON 物件和多樣的回應範例（成功 vs. 錯誤）。

Mock vs. 生產：仔細設定環境，以便公開使用者可以安全地對 Mock 伺服器進行測試，而內部團隊可以存取 Staging 或生產環境。

這種互動循環正是 Apidog 文件優於靜態 PDF 或繁重 Word 文件的地方。

繼續閱讀 → 進階發布設定

給消費者的互動功能

「Try it out」控制台#

管理環境#

請求程式碼生成#

自訂範例#