swagger
- @Api(value = “”,tags = “”)
用在controller上 - @ApiOperation()
用在controller下面的方法上 - @ApiModel(value = “”,description = “”)
用于自建的入参对象xxxDTO类上 - Serializable
用于自建的对象,implements,进行序列化 - @ApiModelProperty(value =“”)
用于自建的入参对象xxxDTO类里的参数 - @ApiImplicitParams({@ApiImplicitParam(value = “”,name = “”,required = true/false)})
swagger参数说明
web注解
- @JsonFormat(pattern = “yyyy-MM-dd”,timezone = “GMT+8”)
在自建的出参对象VO中,自动将时间转换为yyyy-mm-dd格式的数据 - @RequestParam(value = “”,required = false)
入参参数绑定,默认必传,可 通过修改required改变是否必传 - @RequestBody
以json格式传递参数 - @PostMapping("/)
- @GetMapping(“/”)
- @RestController
- @PathVariable(“id”)
用于绑定资源路径上的参数,例如@GetMapping(“/list/{id}”)
将controller执行后的数据以json格式返回前端
参数校验
- @Validated
开启对象Test参数检验,例如public String list(@Validated Test test){} - @NotNull(message = “XXX不能为空”)
检验该参数不能为空,用于自建的入参对象xxxDTO里面的参数上面 - @Min
- @Max
- @pattern(regexp = 正则表达式)
等其他注解,参考https://blog.csdn.net/zhangkaixuan456/article/details/122231894或自行百度
对象
- @JsonSerialize(using = ToStringSerializer.class)
前端传string类型,后端对象可以设置自己想使用的类型。比如Long、Integer等,也可以修改ToStringSerializer,让前端传其他类型,加了此注解后就自动转换 - @JsonFormat(pattern = “yyyy-MM-dd”, timezone = “GMT+8”)
时间格式转换注解 - @Accessors
给对象开启链式编程