rest - Swagger 和 JWT token 认证

Question

我正在构建一些 Swagger 文档，一切都很好，只是我想让页面以交互方式工作，所以在选择编辑器或 UI 时，如果我点击授权按钮，我会调用我的身份验证 URL 来构建 JWT token 然后在后续请求中使用。

我计划向 API 客户端发布一个 Api 访问 key 和一个 secret 访问 key ，并希望点击一个身份验证页面来处理这些并构建 JWT token 。

让我震惊的是，如果我能在 Swagger 中获得如何实现这一目标的正确定义，我将拥有一个现成的测试客户端，然后用于我的新代码。

是的，这是我第一次使用 JWT，我还没有构建代码。你能说“API优先”吗？

Answer 1

这就是我将 Swagger 与 JWT 身份验证结合使用的方式:

编写 Express.js API 端点以生成 JWT。

创建一个 Swagger 路径以使用上述端点检索 JWT

在 swagger.yaml 根级别:

securityDefinitions:  
  JWT:  
    type: apiKey  
    in: header  
    name: access_token  

在 swagger.yaml 路径中:

security  
 -JWT: []

这将在浏览器的 Swagger UI 中显示授权按钮。

在点击上方授权按钮时弹出的认证窗口中输入上面生成的 JWT

现在 JWT 将与请求 header 一起传递

希望这可以帮助其他人。