@NotNull
适用于基本数据类型(Integer,Long,Double等等),当 @NotNull 注解被使用在 String 类型的数据上,则表示该数据不能为 Null(但是可以为 Empty)
@NotBlank
适用于 String 类型的数据上,加了@NotBlank 注解的参数不能为 Null 且 trim() 之后 size > 0
@NotEmpty
适用于 String、Collection集合、Map、数组等等,加了@NotEmpty 注解的参数不能为 Null 或者 长度为 0
在使用这些注解的时候,还需要注意一点(注:否则会造成注解无效哦!!),那就是在Controller 层定义方法的时候在参数位置上加上 @Valid(javax.validation.Valid)
public CommonResult<Object> AddQualityGuarantee(@Valid @RequestBody AddQualityGuaranteeVO params) {
}
//如果引入的参数是一个对象,对象头参数头上加上@Valid()
@ApiModel("XXXXXXXXX")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AddQualityGuaranteeVO {
@ApiModelProperty(value = "车辆信息", required = true, example = "")
@Valid()
private CarInfoVO carInfoVO;
@ApiModelProperty(value = "XXXXXXXXX", required = true, example = "")
@Valid()
private ProductInfoVO productInfoVO;
}
//属性
@ApiModel("车辆信息")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class CarInfoVO {
@ApiModelProperty(value = "车架号", required = true, example = "")
@NotBlank(message = "车架号不能为空")
private String carFrameNum;
@ApiModelProperty(value = "车主姓名", required = true)
@NotBlank(message = "车主姓名不能为空")
private String customerName;
@ApiModelProperty(value = "联系方式", required = true)
@NotBlank(message = "联系方式不能为空")
private String cellphone;
}
作用范围 | API | API常用参数 | 作用位置 |
---|---|---|---|
协议集描述 | @Api | @Api(tags = {“tag1”,“tag2”,“…”}) | controller类 |
协议描述 | @ApiOperation | @ApiOperation(value = “功能描述”,notes = “备注”) | controller类的方法 |
描述返回对象的意义 | @ApiModel | @ApiModel(value=“类名”,description=“类描述”) | 返回对象类 |
对象属性 | @ApiModelProperty | @ApiModelProperty(value = “类属性描述”,required = true,example = “属性举例”,notes = “备注”) | 出入参数对象的字段 |
非对象参数集 | @ApiImplicitParams | @ApiImplicitParams({@ApiImplicitParam(),@ApiImplicitParam(),…}) | controller的方法 |
非对象参数描述 | @ApiImplicitParam | @ApiImplicitParam(name = “参数名”,value = “参数描述”,required = true,paramType = “接口传参类型”,dataType = “参数数据类型”) | @ApiImplicitParams的方法里用 |
Response集 | @ApiResponses | @ApiResponses({ @ApiResponse(),@ApiResponse(),…}) | controller的方法 |
Response | @ApiResponse | @ApiResponse(code = 10001, message = “返回信息”) | @ApiResponses里用 |
忽略注解 | @ApiIgnore | @ApiIgnore | 类,方法,方法参数 |