1、与模型相关的注解
两个注解:
@ApiModel
:用在模型类上,对模型类做注释;@ApiModelProperty
:用在属性上,对属性做注释
2、与接口相关的注解
@Api()
用于类;
表示标识这个类是swagger的资源@ApiOperation()
用于方法;
表示一个http请求的操作@ApiParam()
用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等)@ApiModel()
用于类
表示对类进行说明,用于参数用实体类接收@ApiModelProperty()
用于方法,字段
表示对model属性的说明或者数据操作更改@ApiIgnore()
用于类,方法,方法参数
表示这个方法或者类被忽略@ApiImplicitParam()
用于方法
表示单独的请求参数@ApiImplicitParams()
用于方法,包含多个 @ApiImplicitParam