springboot2.6以上兼容swagger3.0问题 knife4j风格_unresolved dependency: 'com.github.xiaoymin:knife4-优快云博客

本文链接：https://blog.youkuaiyun.com/bighacker/article/details/128037638

本文介绍了如何在Spring Boot项目中使用Knife4j替代Swagger，简化POM文件，仅需引入一个jar包，并配置YML文件启用Ant Path Matcher。同时，提供了Swagger配置类的示例，展示了如何设置API信息和选择Controller包进行扫描。对于兼容性问题的代码段，指出其实可以省略。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.pom文件

/*knife4j-spring-boot-starter这个jar包包含了 swagger依赖
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>*/
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

2.yml配置文件添加

spring: mvc: pathmatch: matching-strategy: ant_path_matcher

3.swagger配置类，兼容问题的那段代码我试了下，可以去掉

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        ApiSelectorBuilder builder = new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.xx.xx.controller"))
                .paths(PathSelectors.any());
        return builder.build();
    }

    private static ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xx服务")
                .description("API文档")
                .termsOfServiceUrl("http://localhost:8888/doc.html")
                .version("1.0")
                .build();
    }

    // 解决兼容问题，必须添加
    @Bean
    public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier,
                             ServletEndpointsSupplier servletEndpointsSupplier, ControllerEndpointsSupplier controllerEndpointsSupplier,
                             EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties,
                             WebEndpointProperties webEndpointProperties, Environment environment) {
        List<ExposableEndpoint<?>> allEndpoints = new ArrayList();
        Collection<ExposableWebEndpoint> webEndpoints = webEndpointsSupplier.getEndpoints();
        allEndpoints.addAll(webEndpoints);
        allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
        allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
        String basePath = webEndpointProperties.getBasePath();
        EndpointMapping endpointMapping = new EndpointMapping(basePath);
        boolean shouldRegisterLinksMapping = this.shouldRegisterLinksMapping(webEndpointProperties, environment, basePath);
        return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints, endpointMediaTypes, corsProperties.toCorsConfiguration(),
                new EndpointLinksResolver(allEndpoints, basePath), shouldRegisterLinksMapping, null);
    }

    private boolean shouldRegisterLinksMapping(WebEndpointProperties webEndpointProperties, Environment environment, String basePath) {
        return webEndpointProperties.getDiscovery().isEnabled() && (StringUtils.hasText(basePath) || ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
    }

}