我如何在Swagger规范（Swagger.json）中表示'authorization:barer'

Question

我试图传达身份验证/安全方案需要设置一个头，如下所示：

Authorization: Bearer <token>

这是我根据swagger文档所做的：

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

Answer 1

OpenAPI3.0现在在本地支持承载/JWT身份验证。它的定义是这样的：

openapi: 3.0.0
...

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT  # optional, for documentation purposes only

security:
  - bearerAuth: []

这在Swagger UI 3.4.0+和Swagger Editor 3.1.12+中支持（同样，仅适用于OpenAPI 3.0规范！）。

UI会显示“授权”按钮，您可以点击该按钮并输入承载令牌（只是令牌本身，没有“承载”前缀）。之后，将使用authorization:barer xxxxxx头发送“try it out”请求。

如果您使用Swagger UI，并且由于某种原因，需要以编程方式添加authorization头，而不是让用户单击“authorize”并输入令牌，则可以使用RequestInterceptor。此解决方案适用于Swagger UI3.x；UI2.x使用了一种不同的技术。

// index.html

const ui = SwaggerUIBundle({
  url: "http://your.server.com/swagger.json",
  ...

  requestInterceptor: (req) => {
    req.headers.Authorization = "Bearer xxxxxxx"
    return req
  }
})

Answer 2

也许这能有所帮助：

swagger: '2.0'
info:
  version: 1.0.0
  title: Based on "Basic Auth Example"
  description: >
    An example for how to use Auth with Swagger.

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

您可以复制并粘贴到这里:http://editor.swagger.io/#/查看结果。

在swagger editor web中也有一些具有更复杂的安全配置的示例，可以为您提供帮助。