Swagger UI 身份验证标头

Question

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

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

---

解决方案尝试

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

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

security: [ { jwt: [] } ]

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

Answer 1

security 密钥中的安全方案名称必须与 securityDefinitions 中使用的名称匹配：

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

security:
  - UserSecurity: []

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