使用 Security Scheme

在資料夾層級設定 Security Scheme

1

選取任一資料夾，點擊右側的 Auth 分頁，並選擇 Security Scheme 作為驗證類型。

選擇 security scheme 驗證類型

2

從下拉選單中選取所需的 Security Scheme。

選取所需的 security scheme

3

如果你選擇 OAuth 2.0 作為 security scheme，則可以進一步選取所需的 Scopes。

選取 security scheme scope

在資料夾層級設定的 security scheme 會套用到該資料夾底下的所有子資料夾與端點，除非它們有自己的 auth 設定。

在端點層級設定 Security Scheme

1

選取任一端點，並前往右側的 Edit 分頁。在 Request 區段中，選擇 Security Scheme 作為授權類型。

在端點層級設定 security scheme

2

從下拉選單中選取所需的 Security Scheme。

為端點選取所需的 security scheme

3

如果你選擇 OAuth 2.0 作為 security scheme，則可以進一步選取所需的 Scopes。

選取端點 security scheme scope

在端點層級設定的 Auth 設定會覆寫資料夾層級的設定。

設定 Security Scheme 的預設值

Security scheme 只定義 auth 方法。你仍需在偵錯端點時提供實際的 auth 值。

為避免在端點偵錯期間重複填寫 auth 值，Apidog 允許你設定預設 auth 值。設定後，除非手動覆寫，否則這些預設值會在偵錯時自動使用。如果資料夾已設定預設 auth 值，其底下所有端點都可以使用這些值。

1

從清單中選擇一個 security scheme，並設定 Default Auth Values。

預設 auth 值

2

根據驗證類型填入值：

API Key：輸入你的 key

Basic Auth：輸入使用者名稱與密碼

Bearer Token：輸入 token

OAuth 2.0：輸入 client ID、client secret 等

Other methods：填入對應的值

繼承與自訂 Auth 值

使用 security scheme 時，你可以選擇：

1. 從父資料夾繼承

使用父資料夾或根資料夾中定義的 security scheme 與預設值。

繼承 security scheme

2. 自訂 Auth 值

保留相同的 security scheme，但覆寫其預設值。

自訂 security scheme

使用多個 Security Scheme

Apidog 支援為單一端點設定多個 security scheme，這符合 OpenAPI 規格中定義的多種驗證類型機制：

AND：透過 AND 組合的 security scheme 必須在同一個請求中同時使用（即將推出）。

OR：透過 OR 組合的 security scheme 是替代選項——在指定情境中可使用其中任一個。

使用 Auth 設定中的 + 按鈕來新增更多 security scheme。

新增多個 security scheme

為 OAuth 2.0 Security Scheme 選擇 Scopes

根據 OpenAPI 規格，建立 OAuth 2.0 security scheme 時，應定義所有可能的 Scopes。在端點中使用時，你必須選取所需的 scopes。

為了讓操作更簡單，Apidog 允許你在資料夾層級設定預設 scopes。這些預設值會套用到資料夾中的所有端點——除非你在端點層級手動設定不同的 scopes。

1

在端點的 Auth 設定中，選取 OAuth 2.0。

2

在 Scopes 區段下，你可以查看 security scheme 定義的所有可用 scopes，並選取所需項目。

在端點層級選擇 auth scopes

3

如果端點從父資料夾繼承 scopes，你可以點擊 Reset the scopes to the configuration of the parent folder，將其還原為父資料夾的設定。

重設 scope 設定

使用 OAuth 2.0 Security Scheme 偵錯端點

你可以預先設定一個 token 作為 OAuth 2.0 security scheme 的預設值，這樣你就不需要每次偵錯 API 時都取得新的 token。

在資料夾層級取得 Token 作為預設 Auth 值

1

選取一個資料夾，前往 Auth 分頁，選擇 OAuth 2.0 security scheme，選取 scopes 與 grant type，然後點擊 Get Token。

在資料夾層級取得 OAuth 2.0 token

2

在彈出面板中：

輸入 client ID、client secret 等

點擊 Continue

測試 OAuth 2.0 token security scheme

3

取得 token 後，你可以查看其詳細資訊，包括其到期時間。此 token 可用於資料夾中的所有端點。

在資料夾中查看 token 詳細資訊

在端點層級取得 Token 作為預設 Auth 值

1

選取所需端點，前往 Edit，選擇 OAuth 2.0 security scheme，然後點擊 Get Token。

在端點層級取得 token

2

在彈出面板中：

輸入 client ID、client secret 等

點擊 Continue

在端點層級測試 OAuth 2.0 token security scheme

3

完成授權以取得 token

此 token 將用於偵錯此端點

查看 token 詳細資訊

使用預設 Token 或產生新的 Token 來進行端點偵錯

在 Apidog 中偵錯端點時，你有兩個選項可以套用 auth token：

方法 1：使用預設 Auth Token

執行端點時，前往 Run 面板下的 Auth 分頁。選取 Use Parent Default Auth Values。父資料夾中設定的預設 auth token 將會自動套用到端點請求。

使用預設 auth token 進行端點偵錯

方法 2：產生新的 Token

1

執行端點時，前往 Run 面板下的 Auth 分頁。選取 Set Manually。點擊 Get Token 以開啟 token 產生面板。

產生新的 token 進行端點偵錯

2

在彈出面板中：

輸入 client ID、client secret 等

點擊 Continue

填寫資訊以產生新的 token

3

完成授權以取得 token

此 token 將用於偵錯目前端點

Modified at 2026-06-11 10:26:02

建立安全性方案

線上文件中的安全性方案