02-Swagger所有注解使用说明
一、常用注解
1、总览
@Api: 用于类,标识这个类是swagger的资源
@ApiIgnore: 用于类,忽略该 Controller,指不对当前类做扫描
@ApiOperation: 用于方法,描述 Controller类中的 method接口
@ApiParam: 用于参数,单个参数描述,与 @ApiImplicitParam不同的是,他是写在参数左侧的。如( @ApiParam(name="username",value="用户名")Stringusername)
@ApiModel: 用于类,表示对类进行说明,用于参数用实体类接收
@ApiProperty:用于方法,字段,表示对model属性的说明或者数据操作更改
@ApiImplicitParam: 用于方法,表示单独的请求参数
@ApiImplicitParams: 用于方法,包含多个 @ApiImplicitParam
@ApiResponse: 用于方法,描述单个出参信息
@ApiResponses: 用于方法,包含多个@ApiResponse
@ApiError: 用于方法,接口错误所返回的信息
02、详细介绍
1. @Api
用于类;表示标识这个类是swagger的资源
tags–表示说明
value–也是说明,可以使用tags替代
用法
效果图:
作者:何贤刚 创建时间:2024-02-18 13:53
最后编辑:何贤刚 更新时间:2024-04-19 10:32
最后编辑:何贤刚 更新时间:2024-04-19 10:32