SwaggerAPI注解详解,以及注解常用参数配置

@Api：
作用在类上，用来标注该类具体实现内容。表示标识这个类是swagger的资源 。
参数：

1. tags：可以使用tags()允许您为操作设置多个标签的属性，而不是使用该属性。
2. description：可描述描述该类作用。

@ApiOperation：
用于方法，表示一个http请求的操作 。

@ApiModel：
用于类，表示对类进行说明，用于参数用实体类接收；

@ApiModelProperty：
用于方法，字段 ，表示对model属性的说明或者数据操作更改

@ApiResponse：
用于方法，描述操作的可能响应。

@ApiResponses：
用于方法，一个允许多个ApiResponse对象列表的包装器。

@ApiParam：
用于方法，参数，字段说明，表示对参数的添加元数据（说明或是否必填等）

@Authorization：
声明要在资源或操作上使用的授权方案。

@AuthorizationScope：
介绍一个OAuth2授权范围。

@ResponseHeader：
响应头设置，使用方法。

@PathVaribale 获取url中的数据

@RequestParam 获取请求参数的值

@GetMapping 组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写

@RequestParam注解给我们提供了这种解决方案，即允许用户不输入id时，使用默认值，具体代码如下：

@RequestMapping(value="/hello",method= RequestMethod.GET) //required=false 表示url中可以不穿入id参数，此时就使用默认参数 public String sayHello(@RequestParam(value=“id”,required = false,defaultValue = “1”) Integer id){ return “id:”+id; }

如果在url中有多个参数，即类似于localhost:8080/hello?id=98&&name=wojiushimogui这样的url，同样可以这样来处理。具体代码如下：

@RequestMapping(value="/hello",method= RequestMethod.GET) public String sayHello(@RequestParam(“id”) Integer id,@RequestParam(“name”) String name){ return “id:”+id+ " name:"+name; }

put与post等同，用来向服务器提交信息。put语义上更偏向于更新操作；而post语义则偏向于新增。

@Data
导入依赖：lombok.Data。
通过activityListParam.是可以点出没有写的Get,Set等方法

@Data : 注解在类上, 为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法
@Getter/@Setter : 注解在类上, 为类提供读写属性
@ToString : 注解在类上, 为类提供 toString() 方法
@Slf4j : 注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象
@Log4j : 注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象

@Data注解在类上时，简化java代码编写，为该类提供读写属性，还提供了equals(),hashCode(),toString()方法

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsContructor。是Lombok插件三种生成不同构造方法的注解，来完成项目中不同构造方法的需求。

@NoArgsConstructor ： 生成一个无参数的构造方法
@AllArgsContructor： 会生成一个包含所有变量全参构造方法
@RequiredArgsConstructor： 会生成一个包含常量，和标识了NotNull的变量的构造方法。生成的构造方法是私有的private。
主要使用前两个注解，这样就不需要自己写构造方法，代码简洁规范。