SpringBoot整合knife4j

SpringBoot整合knife4j

依赖

// https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter
implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

// https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter
implementation group: 'com.github.xiaoymin', name: 'knife4j-spring-boot-starter', version: '3.0.3'

配置文件

import com.fasterxml.classmate.TypeResolver;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 作用: 自动生成API文档和在线接口调试工具
 */

@Configuration
// 该注解是Springfox-swagger框架提供的使用Swagger注解，该注解必须加
@EnableSwagger2
// knife4j提供的增强扫描注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能
@EnableKnife4j
public class Knife4jConfig {

    /**
     * 创建一个Docket的对象，相当于是swagger的一个实例 ： 配置开发和测试环境下开启Swagger，生产发布时关闭
     * <p>
     * RequestHandlerSelectors,配置要扫描接口的方式
     * basePackage：指定扫描的包路径
     * any：扫描全部
     * none：全部不扫描
     * withClassAnnotation:扫描类上的注解，如RestController
     * withMethodAnnotation:扫描方法上的注解，如GetMapping
     *
     * @return
     */
    @Autowired
    TypeResolver typeResolver;

    @Bean
    public Docket createRestApi(Environment environment) {

        // 设置显示的swagger环境信息,判断是否处在自己设定的环境当中,为了安全生产环境不开放Swagger
        Profiles profiles = Profiles.of("default", "dev", "test");
        boolean flag = environment.acceptsProfiles(profiles);

        // 创建一个Docket的对象，相当于是swagger的一个实例
        return new Docket(DocumentationType.OAS_30)
                .useDefaultResponseMessages(false)
                .groupName("1.x版本")
                .apiInfo(apiInfo())
                // 只有当springboot配置文件为dev或test环境时，才开启swaggerAPI文档功能
                .enable(flag)
                .select()
                // 这里指定Controller扫描包路径:设置要扫描的接口类，一般是Controller类
                .apis(RequestHandlerSelectors.basePackage("com.xxx.xxx.controller"))  // 这里采用包扫描的方式来确定要显示的接口
                // .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) // 这里采用包含注解的方式来确定要显示的接口
                // 配置过滤哪些，设置对应的路径才获取
                .paths(PathSelectors.any())
                .build();
    }

    /// 配置相关的api信息
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .description("API调试文档")
                //作者信息
                .contact(new Contact("曳戈泰尔", "http://127.0.0.1:8080/doc.html", "yegetaier7977@qq.com"))
                .version("v1.0")
                .title("API文档")
                //服务Url
                .termsOfServiceUrl("http://127.0.0.1:8080")
                .build();
    }
}

配置修改

# 如果没有报错，可以跳过这个环节

# 当 springboot 版本为 2.6.x 或更高时，由于 Springfox 使用的路径匹配是基于 AntPathMatcher，而 Spring Boot 2.6.X 使用的是 PathPatternMatcher，所以需要将 MVC 的路径匹配规则改成 AntPathMatcher，在配置文件中加入如下参数即可
spring.mvc.pathmatch.matching-strategy=ant_path_matcher