Springboot + vue前后端分离后台管理系统(6)之集成Knife4j和数据验证

一、集成Knife4j

参考链接：https://www.kuangstudy.com/bbs/1349947853841158146
官网参考地址：https://doc.xiaominfo.com/knife4j/documentation/get_start.html

1.1 引入POM

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.8</version>
</dependency>

2年没更新过的Swagger最近更新了一版Swagger3,但网上是对新丝袜哥的评价不高。实际使用的时候还是建议采用三方集成的一些swagger2.X工具，比如我私用的 Knife4j

1.2 加入配置

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
    @Value("${swagger.enabled}")
    private boolean enable = true;

    @Bean(value = "api")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .enable(enable)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("1.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.jatej.ruoyivue.*.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    /**
     * @Description: 构建 api文档的信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("仿若亦SpringBoot+Vue项目接口文档")
                // 设置联系人
                .contact(new Contact("jatej", "see more at..","[email protected]"))
                // 描述
                .description("controller层接口如下")
                // 定义版本号
                .version("1.0").build();
    }

}

1.3 使用

@Slf4j
@RestController
@RequestMapping("/sysUser")
@Api(tags = "用户模块")
public class SysUserController extends BaseController {

    @Autowired
    private SysUserService sysUserService;

    @GetMapping("list")
    @ApiOperation(value = "获取用户列表")
    public Result list(@Valid SysUser sysUser){
        log.info("+++++++++++++++++++++++++测试info日志配置+++++++++++++++++++++++++");
        log.warn("+++++++++++++++++++++++++测试warn日志配置+++++++++++++++++++++++++");
        log.error("+++++++++++++++++++++++++测试error日志配置+++++++++++++++++++++++++");
        return Result.ok().data("items",sysUserService.list());
    }
}

重启服务器后访问http://localhost:7777/doc.html

注:后续集成了token后，添加全局参数在此添加即可，不需要单独进行配置

二、后台数据验证

2.1  引入依赖

 <!-- springboot 2.3之后消失的hibernate-validator解决方法-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2.2 使用

参考地址：https://www.ycbbs.vip/?cat=34&paged=2

上面地址通过三篇文章详细说明了后台验证的使用方式，故不再重复讲解