SpringBoot各类注解的学习

SpringBoot各类注解的学习

尽快学会各类常用注解

---

1、@ApiModel()和@ApiModelProperty

（1）@ApiModel()用于实体类，标记类是swagger的解析类。
value–类名
description–描述

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

使用场景
在实体类上边使用，标记类时swagger的解析类

概述
提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省

属性

属性名称	数据类型	默认值	说明
value	String	类名	为模型提供备用名称
description	String	“”	提供详细的类描述
parent	Class<?> parent	Void.class	为模型提供父类以允许描述继承关系
discriminatory	String	“”	支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型
reference	String	“”	指定对应类型定义的引用，覆盖指定的任何其他元数据

@ApiModelProperty
使用场景
使用在被 @ApiModel 注解的模型类的属性上

概述
添加和操作模型属性的数据

属性

属性名称	数据类型	默认值	说明
value	String	“”	属性简要说明
name	String	“”	运行覆盖属性的名称。重写属性名称
allowableValues	String	“”	限制参数可接收的值，三种方法，固定取值，固定范围
access	String	“”	过滤属性，参阅:io.swagger.core.filter.SwaggerSpecFilter
notes	String	“”	目前尚未使用

2、 @ApiOperation注解

@ApiOperation不是spring自带的注解是swagger里的

com.wordnik.swagger.annotations.ApiOperation;

@ApiOperation和@ApiParam为添加的API相关注解&#