我如何在 Swagger 规范 (swagger.json) 中表示 'x-access-token: <token>'

Question

我试图传达 authentication/security 方案需要设置 header 如下：

x-access-token: <token>

下面是我在基于 OSA3 的 Swagger 文档中的安全组件

   "securitySchemes": {
        "bearerAuth": {
          "type": "http",
          "scheme": "bearer",
          "bearerFormat": "JWT"
        }
      }
    },
    "security": [
      {
        "bearerAuth": []
      }
    ]

但是当我尝试使用 JWT 令牌作为

时，它不起作用并出现错误

{
  "success": false,
  "message": "Auth token is not supplied"
}

请帮我看看 securitySchemes 哪里做错了？

我已经查看了其他 Whosebug 答案，但是只有当我们提供 Authorization: Bearer <token>

时才有用

Answer 1

我使用的解决方法是将其作为参数包含在内，然后为所需路径调用该参数。这不是很方便，但它允许从 swagger 文档页面进行测试，因为它按预期发送授权 header：

components:
 parameters:
   AccessToken:
      name: "x-access-token"
      in: header
      description: Access Token.
      required: true
      schema:
        type: string

并且在所需的路径上：

  parameters:
    - $ref: '#components/parameters/AccessToken'

我如何在 Swagger 规范 (swagger.json) 中表示 'x-access-token: <token>'

How can I represent 'x-access-token: <token>' in a Swagger Spec (swagger.json)

swagger

swagger-ui

openapi