Swagger注解-@Authorization 和 @AuthorizationScope

最新推荐文章于 2025-07-07 16:20:15 发布

原创最新推荐文章于 2025-07-07 16:20:15 发布 · 1w 阅读

CC 4.0 BY-SA版权

文章标签：

12 篇文章

订阅专栏

11 篇文章

订阅专栏

本文深入讲解Swagger注解的使用，包括@Authorization、@AuthorizationScope、@Api等关键注解的功能和应用场景，帮助开发者更好地理解并应用Swagger注解，提升API文档的规范性和可读性。

@Authorization

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

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

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

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

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

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