jwt - Swagger UI 身份验证 header

Question

目前我有一个流程，用户可以通过该流程获取 JSON Web token (JWT)。然后使用此 JWT 为 API 的所有 http 请求设置 X-Access-Token header 。我无法弄清楚如何执行此操作。

我相信可以添加到 api_definition.yaml 中，以便出现一个字段，用户可以在其中输入他们的 JWT，然后可以将其作为标题添加到所有调用中。

---

解决方案尝试

我将以下内容添加到 api_definition.yaml

securityDefinitions:
  UserSecurity:
    type: apiKey
    in: header
    name: X-Access-Token

security: [ { jwt: [] } ]

这似乎并没有改变 Swagger-UI 中的任何内容，我不完全确定如何做到这一点以便用户可以输入他们的 key ？

Answer 1

security key 中的安全方案名称必须与 securityDefinitions 中使用的名称相匹配:

securityDefinitions:
  UserSecurity:
    type: apiKey
    in: header
    name: X-Access-Token

security:
  - UserSecurity: []

然后您应该会在 Swagger UI 标题中看到 Authorize 按钮。