Swagger 注解说明

Swagger的注解位于swagger-annotations基础jar包中,如图:

常用注解说明

@Api:一般用于Controller中,用于接口分组,使用如下图：

@ApiOperation:接口说明,用于api方法上

@ApiImplicitParam:参数说明,适用于只有一个请求参数,主要参数 | 模块名称 | 说明 | | :--- | :--- | | name | 参数名称 | | value | 参数中文说明 | | required | 是否请求必须,boolean值 | | dataType | 数据类型 |

@ApiImplicitParams:多个参数说明,主要参数参考上面@ApiImplicitParam
@ApiModelProperty:实体参数说明

实体类：

Controller类: