注解 位置 说明
@Api 类 加载Controller类上,表示对类的说明
@ApiModel 类(通常是实体类) 描述实体类的作用,通常表示接口接收参接收参数 实体对象
@ApiModelProperty 方法 描述实体类的属性,(用对象接收参数时,描述对象的一个字段)
@ApiOperation 方法 说明方法的用途,作用
@ApiImplicitParams 方法 表示一组参数说明
@ApiImplicitParam 方法 用在@ApiImplicitParams注解中,指定一个请求参数的各个方面的属性
@ApiParam 方法入参或者方法之上 单个参数的描述信息,描述form表单,url参数
@ApiImplicitParam注解详解:
属性 取值 作用
paramType 查询参数类型
path 以地址的形式(rest风格)提交数据 query 直接跟参数完成自动映射赋值(/add/user?name=zhangsan)
body 以流的形式提交 仅支持POST
header 参数在request headers里面提交
form 以form表单的形式提交 仅支持POST
dataType 参数的数据类型 只作为标志说明,并没有实际验证
Long
String
name 接收参数名(方法入参的名称)
value 参数是否必填
required true 必填
false 非必填
defaultValue 默认值
@ApiResponse: HTTP响应其中1个描述
@ApiResponses: HTTP响应整体描述
@Apilgnore: 使用该注解忽略这个API
@ApiError :发送错误返回的信息