接口自动生成工具—knife4j

之前写过关于swagger的接口自动生成的小工具的使用说明文档，后来又发现和学习了一 个可以实现下载和页面更加优雅的工具—knife4j。下面一起来看看吧
1、导入相关的依赖

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

2、在模块中添加一个关于knife4j的配置类

package com.cast.common.knife4j;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Configuration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("1.0")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.cast"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXAPI文档")
                .description("XXXAPI文档")
                .version("1.0")
                .build();
    }
}

注解说明
@EnableSwagger2：该注解是Springfox-swagger框架提供的使用Swagger注解，该注解必须加。
@EnableKnife4j：该注解是knife4j提供的增强注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能,如果你想使用这些增强功能就必须加该注解，否则可以不用加

3、在config包下新建类KnifeConfig，用来开启knife4j

@Configuration
@ComponentScan("com.cast.common.knife4j")
public class KnifeConfig {
}

4、访问：http://域名:端口号/doc.html

二、关于knife4j的使用说明
1、接口数据的文档展示
2、接口调试

3、接口文档的保存

以上就是关于knife4j的搭建和学习，希望可以帮助到大家！