swagger注解的使用

1、背景

前面有介绍过swagger的项目集成步骤，但是没有确切的注解使用内容。https://blog.csdn.net/miwanmeng/article/details/89516176

下面我就对swagger使用注解进行一些比较细化的记录，如果漏了啥，可以在提醒我。下面直接进入主题。

2、内容

@Api

说明：用于controller层类注解，参数有value和tags。都是说明的意思。（注解写在类上）

@ApiOperation(value = "新增")

说明：用于controller层方法注解，value用于方法描述 ，notes用于提示内容 ，tags可以分组说明。都是说明的意思。（注解写在方法上）

@ApiParam() 

说明：用于controller层方法参数注解，name-参数名 ，value用于参数说明 ，required参数是否必填。（注解写在方法上）

@ApiModel 

说明：用于实体类vo注解，value用于类说明，直接填写类名 ，description用于表示Model描述说明。（注解写在类上）

@ApiModelProperty

说明：用于实体类vo参数注解，value用于参数字段说明，name填写属性名字一般直接写变量名 ，dataType用于填写参数类型，required是否必须填写，example举例一般不用，hidden在swagger中隐藏。（注解写在参数上）

@ApiIgnore()

说明：用于类或者方法上，在swagger中隐藏。（注解写在类或者方法上）

@ApiImplicitParam()

说明：用于controller层类注解方法参数注解。name-参数名 ，value用于参数说明 ，dataType用于填写参数类型，required是否必须填写，example举例一般不用。改注解和@ApiParam类似所以可以二选一使用（注解写在方法的括号里）

@ApiImplicitParams()

说明：用于controller层类注解方法参数注解，其实就是多个@ApiImplicitParam()（注解写在方法的括号里）

2、总结

其实对于swagger还是比较简单的，以上就是我常用的注解，不过应该每个注解还有很多其他的参数，这上面只是我用的时候经常用到的一些。