Swagger2-Api与Validated基本用法

一、Swagger2-Api

搭建swagger网址：https://blog.youkuaiyun.com/u013985664/article/details/80009274

• 常用注解

- @Api()用于类； 表示标识这个类是swagger的资源 
- @ApiOperation()用于方法； 表示一个http请求的操作 
- @ApiParam()用于方法，参数，字段说明； 表示对参数的添加元数据（说明或是否必填等） 
- @ApiModel()用于类 表示对类进行说明，用于参数用实体类接收 
- @ApiModelProperty()用于方法，字段 ：表示对model属性的说明或者数据操作更改 
- @ApiIgnore()用于类，方法，方法参数 ：表示这个方法或者类被忽略 
- @ApiImplicitParam() 用于方法 ：表示单独的请求参数 
- @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

二、Validation

1. 概述

@Valid是使用Hibernate validation的时候使用

@Validated是只用Spring Validator校验机制使用

说明：java的JSR303声明了@Valid这类接口，而Hibernate-validator对其进行了实现；

@Validation对@Valid进行了二次封装，在使用上并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同；

1. 注解位置

@Validated：用在类型、方法和方法参数上，但不能用于成员属性，能配合嵌套验证注解@Valid进行嵌套验证。

@Valid：可以用在方法、构造函数、方法参数和成员属性上

 

1. 分组校验

@Validated：提供分组功能，可以在参数验证时，根据不同的分组采用不同的验证机制

@Valid：没有分组功能

分组校验，定义：相应的注解都有groups属性可添加，eg：@Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupB.class})；GroupB为接口

调用：@Validated({IGroupA.class})

如果只是@Validated（）则所有的都会验证

1. 组序列

有时候需要顺序验证，则接口Group需要添加注解@GroupSequence({Default.class, IGroupA.class, IGroupB.class})

调用时再加上@Validated({Group.class})

1. 嵌套验证

@Validated没有提供嵌套验证，待验证的对象，需要在待验证对象上注解@Valid，才能验证待验证对象中的成员属性。

更详细的Validated学习地址：https://mp.weixin.qq.com/s/Vmbp5jEm_aKfo_O20gZqcg