SpringBoot 整合 knife4j 接口文档

knife4j 官网：knife4j

（这里是 V2 版本）

pom.xml 添加依赖：

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

编写配置类代码：config.Knife4jConfiguration

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Knife4j 接口文档配置
 * https://doc.xiaominfo.com/knife4j/documentation/get_start.html
 *
 */
@Configuration
@EnableSwagger2
@Profile("dev")  // 项目再 dev 环境下可以访问
public class Knife4jConfig {

    @Bean
    public Docket defaultApi2() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("project-backend")
                        .description("project-backend")
                        .version("1.0")
                        .build())
                .select()
                // 指定 Controller 扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

编写好对应接口后：

启动Spring Boot工程，在浏览器中访问：http://localhost:8080/doc.html （注意端口为项目对应的端口）

如果出现空指针异常报错，应该是 SpringBoot 版本与 Knife4j 不兼容

可以考虑降低 SpringBoot 版本到 2.6.x 以下，或者在 yam 文件下添加配置信息：

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher