Swagger和JWT令牌认证

Question

我正在构建一些很好的Swagger文档，除了我希望页面可以交互地工作之外，所以在选择编辑器或UI时，如果我单击了Authorize按钮，则将调用构建JWT令牌的Authentication URL。然后在后续请求中使用。

我打算向API客户端颁发Api访问密钥和秘密访问密钥，并希望访问一个身份验证页面，该页面将对其进行处理并构建JWT令牌。

令我惊讶的是，如果我能够在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将与请求标头一起传递

希望这可以帮助其他人。