我们如何传递用户信息以限制swagger API端点

Question

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

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

Answer 1

您没有提到您正在使用哪种版本的swagger，但看起来支持使用Swagger 2.0和3.0通过某种身份验证来保护端点。

来自2.0 docs：

  

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

     

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

来自3.0 docs：

  

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

     

HTTP身份验证方案（他们使用Authorization标头）：           基本           来人           RFC 7235和HTTP Authentication Scheme Registry定义的其他HTTP方案       标头，查询字符串或Cookie中的API密钥           Cookie身份验证       OAuth 2       OpenID Connect Discovery

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