swagger整合knife4j

1.swagger依赖选型

我们这里先导入swagger需要的两个依赖

    <dependencies>
        <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>
    </dependencies>

这是swagger所需要的两个依赖

2.swagger注意事项

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务

而在swagger底层种提供了独属于swagger的前台可视化界面，我们可以在swagger-ui依赖种找到这些前端的可视化界面

2.1swagger可能出现的问题

在我们导入到swagger依赖后他就已经自行提供了对应的html页面以及各种各样的配置，所以在我们使用swagger的时候，需要注意一下，如果在我们的项目中有着面向切面编程之类的技术，我们就需要对对应的swagger路径进行放行，以防我们的swagger出现错误，如404，swagger调用错误等

大部分swagger在我们引入配置类后以及依赖后，在启动swagger的时候出现问题，大部分都是拦截器，过滤器，aop之类的问题

所以我们现在看一下需要方形的swagger需要放行的路径

2.2swagger放行路径

"/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**"

3.整合knif4j

knife4j我们先导入对应的依赖

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

这是knif4j

3.1配置配置文件

底下来导入配置文件

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    /**
     * knife4j配置
     * @return
     */
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("测试==demo")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact(new Contact("code3306", "", "1245157687@qq.com"))
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定文档Controller层扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.xxx.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;

    }

这是我们需要用到的配置文件，我这里也是一样粘贴了，里面有对应的注释，可以查看注释来写

到这一步，swagger整合knife4j算是结束了

底下我们启动试一试效果

4.启动项目

先说一下，我这里是自己新开的一个项目用来写这个文章的，底下我们来启动试一下

然后底下就是加上我们的http://localhost:ip/doc.html来访问swagger了

这里可以是清楚的看到已经好了

5.knife4j文档异常处理

如果在启动的时候出现报错说knife4j文档处理异常，看一下你的后台是不是出现了一个报错叫

ClassNotFoundException: com.fasterxml.jackson.annotation.JsonIncludeProperties

如果是的话我们导入一个新的依赖

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.15.3</version>
        </dependency>

然后我们再重新启动再进knife4j页面就可以正常进了