knife4接口文档整合springboot

旧城等待， 2022-11-10 14:20 179阅读 0赞

##### 添加pom依赖 #####

<dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>2.0.7</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>28.0-jre</version>
            </dependency>

##### 添加配置类 #####

package com.tinet.clink.console.configuration;
    
    import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
    import io.swagger.annotations.Api;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    /** * @author dengshaoxiang * @create 2021-03-15 20:36 **/
    @Configuration
    @EnableSwagger2
    public class Knife4jConfig { 
        @Bean(value = "defaultApi2")
        public Docket defaultApi2() { 
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(new ApiInfoBuilder()
                            //.title("swagger-bootstrap-ui-demo RESTful APIs")
                            .description("渠道组后台接口文档")
                            //.termsOfServiceUrl("http://localhost:8088/api")
                            .contact(new Contact("天润融通","https://www.ti-net.com.cn/","xx@qq.com"))
                            .version("1.0")
                            .build())
                    //分组名称
                    .groupName("2.X版本")
                    .select()
                    //这里指定扫描加了api注解的
                    .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                    .paths(PathSelectors.any())
                    .build();
    
        }
    
    }

##### 效果 #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjQ5MzQy_size_16_color_FFFFFF_t_70]

##### 可能遇到的错误 #####

Description:
     
    An attempt was made to call a method that does not exist. The attempt was made from the following location:
     
        springfox.documentation.schema.DefaultModelDependencyProvider.dependentModels(DefaultModelDependencyProvider.java:79)
     
    The following method did not exist:
     
        com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google/common/collect/FluentIterable;
     
    The method's class, com.google.common.collect.FluentIterable, is available from the following locations:
        jar:file:/D:/apache-maven-3.6.1/repository/com/google/guava/guava/18.0/guava-18.0.jar!/com/google/common/collect/FluentIterable.class
    It was loaded from the following location:
        file:/D:/apache-maven-3.6.1/repository/com/google/guava/guava/18.0/guava-18.0.jar
    Action:
    Correct the classpath of your application so that it contains a single, compatible version of com.google.common.collect.FluentIterable

由于swagger引用的guava版本过低，改成高版本guava即可

解决：https://blog.csdn.net/qinchao\_mei/article/details/93463725

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjQ5MzQy_size_16_color_FFFFFF_t_70]: /images/20221022/b9279014916847889e190b0cf18caa58.png