首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何在Swagger规范(swagger.json)中表示“授权:持有者<token>”

如何在Swagger规范(swagger.json)中表示“授权:持有者<token>”
EN

Stack Overflow用户
提问于 2015-10-02 22:57:43
回答 5查看 202.5K关注 0票数 144

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

代码语言:javascript
复制
Authorization: Bearer <token>

这是我基于swagger documentation所做的

代码语言:javascript
复制
securityDefinitions:
  APIKey:
    type: apiKey
    name: Authorization
    in: header
security:
  - APIKey: []
EN

回答 5

Stack Overflow用户

回答已采纳

发布于 2015-10-07 22:56:56

也许这能有所帮助:

代码语言:javascript
复制
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编辑器web中也有几个示例,它们具有更复杂的安全配置,可以帮助您。

票数 171
EN

Stack Overflow用户

发布于 2020-07-15 11:20:58

使用openapi 3.0.0在JSON中发布2021答案:

代码语言:javascript
复制
{
  "openapi": "3.0.0",
  ...
  "servers": [
    {
      "url": "/"
    }
  ],
  ...
  "paths": {
    "/skills": {
      "put": {
        "security": [
           {
              "bearerAuth": []
           }
        ],
       ...
  },


  "components": {        
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
票数 19
EN

Stack Overflow用户

发布于 2020-10-27 11:13:37

通过使用requestInterceptor,它对我起作用了:

代码语言:javascript
复制
const ui = SwaggerUIBundle({
  ...
  requestInterceptor: (req) => {
    req.headers.Authorization = "Bearer " + req.headers.Authorization;
    return req;
  },
  ...
});
票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/32910065

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档