SpringBoot 2.6以上版本 集成 Knife4j_knife4j哪个版本与springfox-spi3.0.0兼容

Knife4j官网上的例子是基于SpringBoot 2.3.5 和 Knife4j 2.0.7 编写的。
按照官网写法，如果SpringBoot 版本是2.6以及以上就会报错。

SpringBoot 2.6 使用Spring Fox 接口统一api相关的文档接口，我们因此需要使用Knife4j 3.X 版本。

本文只使用了Knife4J的UI，文档框架直接使用Spring Fox

1. 添加依赖

<!-- 文档 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-ui</artifactId>
    <!--在引用时请在maven中央仓库搜索3.X最新版本号-->
    <version>3.0</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13

2. 创建配置

package com.zy.bugmanager.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;



/**
 * @ClassName: WebConfig
 * @Description:swagger接口界面展示配置
 * @Date: 2021/4/29 15:58
 */

@Configuration
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")

                        .version("1.0")
                        .build())
                //分组名称
                .groupName("3.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.zy.bugmanager.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

3. 配置静态资源

@SpringBootApplication
@EnableWebMvc
@MapperScan
public class BugManagerApplication implements WebMvcConfigurer {

    public static void main(String[] args) {
        SpringApplication.run(BugManagerApplication.class, args);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

4. 浏览文档

http://IP:PORT/doc.html