我们如何传递用户信息来限制swagger APIendpoint

Question

我们有一个用例，在这个用例中，我们需要显示用户凭证参数，例如用户名和密码，并且基于用户名值和后端的密码验证，我们必须呈现swagger API。无法理解如何根据身份验证结果呈现swagger API。

任何指针都将受到高度赞赏。

Answer 1

您没有提到您使用的是哪个版本的swagger，但似乎支持通过使用Swagger 2.0和3.0的某种身份验证来保护endpoint。

从2.0文档中：

Swagger 2.0允许您为API定义以下身份验证类型：

基本身份验证API密钥（作为报头或查询字符串参数）OAuth 2公共流（授权代码、隐式、资源所有者密码凭据、客户端凭据）

从3.0文档中：

OpenAPI使用术语安全方案来表示身份验证和授权方案。OpenAPI 3.0允许您描述使用以下安全方案保护的API：

HTTP身份验证方案（它们使用授权标头）：基本承载器RFC 7235定义的其他HTTP方案和标头中的HTTP身份验证方案注册表API项、查询字符串或cookies Cookie身份验证OAuth 2 OpenID连接发现

这些文档集中的每一个都有到示例和进一步文档的链接。