Swagger在SpringBoot中的注解说明

@ApiOperation说明：

         使用在Controller层中，对这一个接口（即方法）所实现的功能做一个Api说明；

         用以构建Api文档，@ApiOperation(value = "接口说明", httpMethod = "接口请求方式", notes = "接口发布说明", Response = void.Class)

@ApiModelProperty说明：

        使用在方法或者字段上，对model属性的说明或者数据操作更改；

        用以构建Api文档，@ApiModelProperty(value = "字段说明", name= "属性名称", required = "是否必填", example = "举例说明")

 

@ApiModel说明：

        使用在类上，用以说明这个类的作用，比如这个类是数据库哪个表的实体类或者这个Controller所实现的是哪一个业务模块的功能类；

        用以构建Api文档，@ApiModel(value = "党组织对象模型")

 

@Api说明：

        使用在类上，用以说明这个类的作用即可；

        用以构建Api文档，@Api(tags = {"CommunityActivityCarryOutRankingController"}, value = "社团有你_排行榜_社团")