常见swagger注解一览与使用

常见swagger注解一览与使用

最经常使用的5个注解

@Api：修饰整个类，描述Controller的做用

@ApiOperation：描述一个类的一个方法，或者说一个接口

@ApiParam：单个参数描述

 

@ApiModel：用对象来接收参数

@ApiProperty：用对象接收参数时，描述对象的一个字段

 

其它若干

 

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应总体描述

 

 

 

@ApiClass

@ApiError

@ApiErrors

 

 

 

@ApiParamImplicit

@ApiParamsImplicit