使用安全方案

在文件夹级别配置安全方案

1

选择任意文件夹，点击右侧的 Auth 标签页，并选择 Security Scheme 作为身份验证类型。

选择安全方案身份验证类型

2

从下拉菜单中选择所需的 Security Scheme。

选择所需的安全方案

3

如果选择 OAuth 2.0 作为安全方案，还可以进一步选择所需的 Scopes。

选择安全方案范围

在文件夹级别配置的安全方案将应用于该文件夹下的所有子文件夹和端点，除非它们有自己的身份验证配置。

在端点级别配置安全方案

1

选择任意端点并转到右侧的 Edit 标签页。在 Request 部分，选择 Security Scheme 作为授权类型。

在端点级别配置安全方案

2

从下拉菜单中选择所需的 Security Scheme。

为端点选择所需的安全方案

3

如果选择 OAuth 2.0 作为安全方案，还可以进一步选择所需的 Scopes。

选择端点安全方案范围

在端点级别配置的身份验证设置将覆盖文件夹级别的设置。

为安全方案设置默认值

安全方案仅定义身份验证方法。调试端点时，你仍需要提供实际的身份验证值。

为避免在端点调试期间反复填写身份验证值，Apidog 允许你设置默认身份验证值。设置后，调试时会自动使用这些默认值，除非手动覆盖。如果文件夹配置了默认身份验证值，则其下的所有端点都可以使用这些值。

1

从列表中选择一个安全方案并设置 Default Auth Values。

默认身份验证值

2

根据身份验证类型填写值：

API Key：输入你的密钥

Basic Auth：输入用户名和密码

Bearer Token：输入令牌

OAuth 2.0：输入客户端 ID、客户端密钥等

Other methods：填写相应的值

继承和自定义身份验证值

使用安全方案时，你可以：

1. 从父文件夹继承

使用父文件夹或根文件夹中定义的安全方案和默认值。

继承安全方案

2. 自定义身份验证值

保留相同的安全方案，但覆盖其默认值。

自定义安全方案

使用多个安全方案

Apidog 支持为单个端点配置多个安全方案，这与 OpenAPI 规范中定义的多种身份验证类型机制一致：

AND：通过 AND 组合的安全方案必须在同一请求中同时使用（即将推出）。

OR：通过 OR 组合的安全方案是备选项——在给定上下文中可以使用任意一个。

使用 Auth 设置中的 + 按钮添加更多安全方案。

添加多个安全方案

为 OAuth 2.0 安全方案选择范围

根据 OpenAPI 规范，创建 OAuth 2.0 安全方案时，应定义所有可能的 Scopes。在端点中使用它时，必须选择所需的范围。

为简化操作，Apidog 允许你在文件夹级别设置默认范围。这些默认值将应用于文件夹中的所有端点——除非你在端点级别手动设置不同的范围。

1

在端点的 Auth 设置中，选择 OAuth 2.0。

2

在 Scopes 部分下，你可以查看由安全方案定义的所有可用范围，并选择所需的范围。

在端点级别选择身份验证范围

3

如果端点从父文件夹继承了范围，你可以点击 Reset the scopes to the configuration of the parent folder 以恢复为父文件夹配置。

重置范围设置

使用 OAuth 2.0 安全方案调试端点

你可以为 OAuth 2.0 安全方案预先配置一个令牌作为默认值，这样每次调试 API 时就无需重新获取令牌。

在文件夹级别获取令牌作为默认身份验证值

1

选择一个文件夹，转到 Auth 标签页，选择一个 OAuth 2.0 安全方案，选择范围和授权类型，然后点击 Get Token。

在文件夹级别获取 OAuth 2.0 令牌

2

在弹出面板中：

输入客户端 ID、客户端密钥等

点击 Continue

测试 OAuth 2.0 令牌安全方案

3

获取令牌后，你可以查看其详细信息，包括它的过期时间。此令牌可用于文件夹中的所有端点。

在文件夹中查看令牌详情

在端点级别获取令牌作为默认身份验证值

1

选择所需的端点，转到 Edit，选择一个 OAuth 2.0 安全方案，然后点击 Get Token。

在端点级别获取令牌

2

在弹出面板中：

输入客户端 ID、客户端密钥等

点击 Continue

在端点级�别测试 OAuth 2.0 令牌安全方案

3

完成授权以获取令牌

该令牌将用于调试此端点

查看令牌详情

使用默认令牌或生成新令牌进行端点调试

在 Apidog 中调试端点时，你有两种方式来应用身份验证令牌：

方法 1：使用默认身份验证令牌

运行端点时，转到 Run 面板下的 Auth 标签页。选择 Use Parent Default Auth Values。父文件夹中配置的默认身份验证令牌将自动应用于端点请求。

使用默认身份验证令牌进行端点调试

方法 2：生成新令牌

1

运行端点时，转到 Run 面板下的 Auth 标签页。选择 Set Manually。点击 Get Token 打开令牌生成面板。

生成新令牌进行端点调试

2

在弹出面板中：

输入客户端 ID、客户端密钥等

点击 Continue

填写生成新令牌的信息

3

完成授权以获取令牌

该令牌将用于调试当前端点

Modified at 2026-06-09 08:55:47

创建安全方案

在线文档中的安全方案