swagger - 如何在 Swagger 规范中使用 'Authorization: Bearer '

Question

我试图传达身份验证/安全方案需要设置 header ，如下所示:

Authorization: Bearer <token>

这是我根据swagger documentation得到的:

securityDefinitions:
  APIKey:
    type: apiKey
    name: Authorization
    in: header
security:
  - APIKey: []

Answer 1

也许这可以帮助:

swagger: '2.0'
info:
  version: 1.0.0
  title: Bearer auth example
  description: >
    An example for how to use Bearer Auth with OpenAPI / Swagger 2.0.

host: basic-auth-server.herokuapp.com
schemes:
  - http
  - https
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
    description: >-
      Enter the token with the `Bearer: ` prefix, e.g. "Bearer abcde12345".
paths:
  /:
    get:
      security:
        - Bearer: []
      responses:
        '200':
          description: 'Will send `Authenticated`'
        '403': 
          description: 'You do not have necessary permissions for the resource'

您可以将其复制并粘贴到https://editor.swagger.io来查看结果。

Swagger Editor Web 中还有几个具有更复杂安全配置的示例可以为您提供帮助。

重要提示:在此示例中，API 使用者必须包含“Bearer”前缀作为 token 值的一部分。例如，当使用 Swagger UI 的“授权”对话框时，您需要输入 Bearer your_token 而不仅仅是 your_token。