Swagger与knife4j的不同之处

下面写法简单明了不含糊直接干货走起：

1、程序员一般写接口文档比较麻烦，首先是访问路径，请求方式，请求参数，请求列表，请求参数实例，返回结果，返回结果类型，返回结构，返回结构实例，返回参数列表，返回状态码列表等待等。。。没完没了的太多，搞人心态

结果就有了Swagger在线文档，这个文档需要注意的是：3.0版本的前后输入的后缀差别，前→swagger-ui.html，后→swagger-ui/index.html，而且版本的界面是这样的：

这样的： 虽然已经很明细了，但如果在后台新增一些东西，难免会造成页面个别参数（

Example Value）的缺失，还需要手动填写，确实有点蓝瘦香菇；

2、现在发现一个比swagger2更好用的，直接可以下载pdf，word，html，md文档，是不是很高级呢？虽然也是初用，记录下让大家也新鲜新鲜，这个前提也是swagger中的：knife4j

他的界面是这样的：

这样的：

以及这样的：

导出的md是这样的：

是不是给人眼前一亮，回头前端再来跟咱们后端要测试代码的时候，终于可以硬气一点这是文档，拿走不谢，嘿嘿

3、聊了这么多大家是不是流口水了呢！直接上代码：一般knife4j属于common公共类的，所以需要在common中创建一个knife4j（包名随便写，自己看得懂就行）然后就看你的C/V大法是不是功力深厚了，要声明的是：swagger与knife4j之间的区别在于这个注解：@EnableKnife4j

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfiguration {

    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.usian"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo buildApiInfo() {
        Contact contact = new Contact("程序员", "", "");
        return new ApiInfoBuilder()
                .title("头条-平台管理API文档Knife4j")
                .description("平台管理服务api")
                .contact(contact)
                .version("1.0.0").build();
    }

}

common公共类已经完成了，那么该继承公共类的项目进行扫描了，但是这两个包相差的有点远，如何让admin扫描到common里面的knife4j呢，我们需要在admin中创建一个config包，然后创建一个knife4j的实体类，然后将这个类上方添加：@configuration注解，在添加一个包扫描：@ComponentScan("com.包名.knife4j")，注：knife4j在common中的绝对路径

完整版的是这样的，然后就可以启动项目了，访问地址：doc.html

赶紧去试试吧