使用Swagger配置后端验证功能

最新推荐文章于 2024-04-18 14:15:52 发布

程序猿金某

最新推荐文章于 2024-04-18 14:15:52 发布

阅读量504

点赞数

文章标签： java spring boot ide

本文链接：https://blog.csdn.net/weixin_58076210/article/details/129484658

版权

一、添加依赖

对于客户端提交表单或者Ajax中的数据，后端的Controller必须先要做验证，然后才能使用这些数据。既然要验证数据，那么不妨我们来使用一下Validation库。

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-validation</artifactId>
</dependency>

二、创建封装类

validation库在做后端验证的时候，要求必须用封装类（Form类）来保存客户端提交的数据，然后在封装类中，我们可以定义验证的规则，validation会执行这些规则，帮我们验证客户端提交的数据。

package com.example.swagger2.contorller;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotBlank;
@ApiModel
@Data
public class Form {
    @NotBlank                                            //不能为空
  //  @Pattern(regexp = "^[\\u4e00-\\u9fa5]{2,15}$")       //正则表达式
    @ApiModelProperty("姓名")
    private String name;
}

三、编写Web测试端口，获取类Form中的数据

package com.example.swagger2.contorller;



import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;


@RestController
@RequestMapping("/test")
@Api("测试Web接口")
public class TestController {

    @PostMapping("/sayHello")
    @ApiOperation("最简单的测试方法")
    public String sayHello(@Valid @RequestBody Form form){
        return "姓名为："   +form.getName();
    }
}