Apidog 發布的 API 文件提供互動式且全面的 API 檢視方式。當使用者存取你的文件 URL 時，會看到每個端點結構清晰的呈現，並包含多個區段，方便理解與測試。文件結構#
中繼資料#
此區段會顯示必要的端點資訊，例如 URL、HTTP 方法、修改時間與描述。你可以在建立文件時選擇要顯示哪些欄位。端點狀態#
狀態為「Released」的端點不會顯示狀態標籤。其他狀態的端點（例如「Developing」）會在端點名稱後顯示狀態標籤。狀態為「Deprecated」的端點會在左側目錄樹中顯示為「端點名稱」。端點描述#
端點描述中的 Markdown 內容會被渲染並顯示在中繼資料區段的末尾。Try It Out#
點擊「Try it out」可展開互動式測試層，你可以在其中傳送請求、修改參數並切換環境。可用的環境是在建立文件時選取的環境。如果你在建立文件時選取 Cloud mock 環境，即表示你為讀者提供了一個簡單的沙盒環境，用於測試 API。 使用變數#
如果請求範例中使用了 {{variables}}，讀者必須在傳送請求前設定變數值。使用憑證#
設定驗證後——例如使用 Bearer Token 驗證——你會在「Publish Documentation」面板頂部看到「Credentials」區段，可直接輸入 token 值。這種設定方式的主要好處是，驗證資訊可以在不同 API 之間共用。如果多個 API 參照相同的 security scheme 或驗證類型，你只需要輸入一次驗證資訊，其他 API 即可自動重複使用。這些憑證會經過加密並儲存在瀏覽器的 LocalStorage 中，並依瀏覽器工作階段進行管理。在同一個工作階段中，它們可以在多個視窗與分頁之間共用。一旦瀏覽器關閉且工作階段結束，這些憑證就會自動失效。更具體地說：儲存在 LocalStorage 中的憑證會被加密，而解密金鑰則儲存在 session cookie 中。雖然 LocalStorage 中的資料會長期保留，但 session cookie 中的解密金鑰會在瀏覽器關閉時立即過期。因此，加密資料將無法再被解密或存取，你下次造訪時需要重新輸入憑證。此區段會顯示參數與主體規格。Apidog 支援兩種參數顯示樣式——Modern 或 Classic——你可以在 Settings → Feature Settings → Endpoint Feature Settings 中選擇。請求範例#
各種程式語言的請求程式碼範例。你可以在建立分享時選擇是否顯示此模組。回應規格與範例，顯示方式與 Apidog 用戶端中相同。如果你在建立文件時選取「Allow exporting data」，讀者會在右下角以及文件最底部看到匯出選項。讀者可以選擇「Clone」或「Export」。「Export」支援匯出為 OAS、HTML、Markdown 與 Apidog 格式。 Modified at 2026-06-11 10:26:02
