Swagger注解-@Authorization 和 @AuthorizationScope

x33g5p2x  于2021-12-29 转载在 其他  
字(0.5k)|赞(0)|评价(0)|浏览(466)

@Authorization

使用场景

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

概述

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

属性

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

@AuthorizationScope

使用场景

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

概述

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

属性

属性名称数据类型默认值说明
scopeString要使用的 OAuth2 授权方案的范围。范围应事先在Swagger对象的securityDefinition部分中声明
descriptionString在1.5.X中使用,保留用于旧版本的支持

相关文章