swagger的注解使用

swagger的注解使用

类上的注解

@Api(tags = “签到模块”)
在类上使用
效果如下：

方法的注解

@ApiOperation(value = “签到接口”, notes = “”)
方法上使用

参数注解

@RequestParam(required = true) @ApiParam(value = “用户id”, required = true) Integer userId
参数上使用

展示对象里面的字段注解

@ModelAttribute @Valid Check check

效果展示check对象的字段

5.实体类的注释

ApiModelProperty()用于实体类字段
表示对model属性的说明或者数据操作更改
　　value–字段说明
　　name–重写属性名字
　　dataType–重写属性类型
　　required–是否必填
　　example–举例说明
　　hidden–隐藏

3 对接口和实体类添加注释，生成doc。常用的标记如下
@Api()用于类；
标识这个类是swagger的资源
　　tags–表示分组说明标签
@ApiOperation()用于方法；
表示一个http请求的操作
　　value用于方法描述 
　　notes用于提示内容
@ApiModel()用于实体类
表示对类进行说明，用于参数用实体类接收
      value–表示对象名 
      description–描述

@ApiModelProperty()用于实体类字段
表示对model属性的说明或者数据操作更改
　　value–字段说明 
　　name–重写属性名字 
　　dataType–重写属性类型 
　　required–是否必填 
　　example–举例说明 
　　hidden–隐藏

@ApiImplicitParam() 用于 controller 方法
表示单独的请求参数
　　name–参数ming
　　value–参数说明
　　dataType–数据类型
　　paramType–参数类型
　　example–举例说明
@ApiImplicitParams() 用于 controller 方法，包含多个 @ApiImplicitParam

@ApiIgnore()用于类或者方法上，可以不被swagger显示在页面上
说明：简单的标记只需要@Api(tags="") 和 @ApiOperation(value="",notes="")
 
更多关于 注解用法可以参考https://github.com/swagger-api/swagger-core/wiki/Annotations