Swagger注解-@Authorization 和 @AuthorizationScope

我不是女神ヾ 2022-02-14 06:15 752阅读 0赞

# @Authorization #

## 使用场景 ##

接口授权，不单独使用，作为 @Api 或 @ApiOperation 的属性使用

## 概述 ##

定义要在资源或操作上使用的授权方案。使用的授权方案需要首先在Swagger各级别声明。此注解不直接使用，Swagger不会解析，应该作为 @Api 或 @ApiOperation 属性使用

## 属性 ##

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td></td> 
   <td>要在此资源/操作上使用的授权方案名称。必须在资源列表的授权部分中定义名称</td> 
  </tr> 
  <tr> 
   <td>scopes</td> 
   <td>AuthorizationScope[]</td> 
   <td>@AuthorizationScope(scope = “”, description = “”)</td> 
   <td>授权方案为OAuth2时使用的范围</td> 
  </tr> 
 </tbody> 
</table>

# @AuthorizationScope #

## 使用场景 ##

接口授权范围使用，不单独使用，作为 @Authorization 的属性使用

## 概述 ##

描述 OAuth2 授权范围。用于定义操作用于已定义授权方案的授权范围。此注解不直接使用，Swagger不会解析

## 属性 ##

<table> 
 <thead> 
  <tr> 
   <th>属性名称</th> 
   <th>数据类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>scope</td> 
   <td>String</td> 
   <td></td> 
   <td>要使用的 OAuth2 授权方案的范围。范围应事先在Swagger对象的securityDefinition部分中声明</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td></td> 
   <td>在1.5.X中使用，保留用于旧版本的支持</td> 
  </tr> 
 </tbody> 
</table>

发表评论取消回复

表情：

评论列表（有 0 条评论，752人围观）

还没有评论，来说两句吧...

相关阅读

相关 Swagger注解

Swagger是一个开源的API文档工具，可以自动生成API文档，方便开发人员查看和调用API接口。在Java开发中，我们可以使用Swagger注解来描述API接口和参数，从而

短命女/ 2024年03月16日 18:34/ 0 赞/ 81 阅读

相关 swagger注解。

类注解 @Api（类注解） value > > 表示类的链接地址，访问此类的URL中需要加/，必填。 > > > > des

曾经终败给现在/ 2024年02月18日 17:33/ 0 赞/ 76 阅读

相关 Swagger——介绍、使用Swagger注解

目录 Swagger 1、什么是Swagger 2、官方提供的工具 3、构建Swagger与SpringBoot

Love The Way You Lie/ 2023年02月27日 08:27/ 0 赞/ 18 阅读

相关 Swagger注解

@API详细说明 ![这里写图片描述][70] @ApiImplicitParam ![这里写图片描述][70 1] [70]: /images/202205

傷城~/ 2022年05月22日 07:37/ 0 赞/ 331 阅读

相关 Swagger注解-@ApiModel 和 @ApiModelProperty

@ApiModel 使用场景在实体类上边使用，标记类时swagger的解析类概述提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省

灰太狼/ 2022年02月14日 06:19/ 0 赞/ 448 阅读

相关 Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam

@ApiImplicitParams 使用场景在 Rest 接口方法上使用来指定请求参数概述在 Rest 接口方法上使用来指定请求参数属性

墨蓝/ 2022年02月14日 06:19/ 0 赞/ 2078 阅读

相关 Swagger注解-@ApiResponses 和 @ApiResponse

@ApiResponses 代码示例 [github 代码示例： https://github.com/CoderFreeMan/swagger-demo][git

约定不等于承诺〃/ 2022年02月14日 06:17/ 0 赞/ 1597 阅读

相关 Swagger注解-@Authorization 和 @AuthorizationScope

@Authorization 使用场景接口授权，不单独使用，作为 @Api 或 @ApiOperation 的属性使用概述定义要在资源或操作上使用的授

我不是女神ヾ/ 2022年02月14日 06:15/ 0 赞/ 753 阅读

相关 Swagger注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 @Api：修饰整个类，描述Controller的作用

短命女/ 2021年10月18日 22:46/ 0 赞/ 555 阅读

相关 Swagger注解-@ApiModel 和 @ApiModelProperty

@ApiModel 使用场景在实体类上边使用，标记类时swagger的解析类概述提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省属性

系统管理员/ 2021年02月17日 09:02/ 2 赞/ 4277 阅读