Spring Boot教程 | 第八篇：Spring Boot整合knife4j（swagger-bootstrap-ui）实现自动API文档_com.github.xiaoymin.knife4j.annotations.apisort;-CSDN博客

本文链接：https://blog.csdn.net/tuoyun6647/article/details/106021012

一、简介

swagger

在前后端分离的项目中，接口文档是前后端沟通联调的重要工具。一般我们后端人员会使用接口文档工具（如小幺鸡甚至Excel等）编写接口文档。对于后端开发来说，编写这个json格式的接口说明，本身也是有一定负担的工作，特别是在后面持续迭代开发的时候，往往会忽略更新这个接口说明，直接更改代码。久而久之，接口文档由于缺乏维护，也和实际项目渐行渐远，甚至失去了参考意义。（Ps：部门目前需要对外发布的接口文档以及需要特殊描述的接口仍使用工具进行人工编写）

因此我们希望引入某项工具，可以扫描相关的代码，动态生成与代码一致的接口说明。基于此背景，出现了Swagger 框架。Swagger定义了一套接口规范，通过这套规范，你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等。

springfox-swagger

springfox-swagger是一套基于Swagger（结合Spring与Swagger），帮助开发者自动生成API文档的工具。由于UI页面不是很清晰友好，因此国人基于springfox-swagger打造出了swagger-bootstrap-ui。

swagger-bootstrap-ui

swagger-bootstrap-ui是基于springfox-swagger的增强UI实现，以文档说明和在线调试为核心，为Java开发者在使用Swagger的时候，能拥有一份简洁、强大的接口文档体验。Swagger-Bootstrap-UI 替换Swagger 默认的UI实现左右菜单风格的Swagger-UI ，让其看起来更清晰明了。

knife4j

随着项目略显臃肿，作者将项目正式更名为knife4j,并做了调整改进。

（一句话总结就是：knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案）

作者原文如下:“但是随着项目的发展,面对越来越多的个性化需求,不得不编写后端Java代码以满足新的需求,在swagger-bootstrap-ui的1.8.5~1.9.6版本之间,采用的是后端Java代码和Ui都混合在一个Jar包里面的方式提供给开发者使用.这种方式虽说对于集成swagger来说很方便,只需要引入jar包即可,但是在微服务架构下显得有些臃肿。因此,项目正式更名为knife4j,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍,更名也是希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端”

官网地址：https://doc.xiaominfo.com/knife4j/

二、搭建

2.1使用2.0.2版本

引入pom依赖

        <!-- knife4j（swagger）依赖 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <!--在引用时请在maven中央仓库搜索最新版本号-->
            <version>2.0.2</version>
        </dependency>

新建config包，创建swagger的配置类

配置类代码如下（注意按照自己的项目配置包扫描路径）：

package com.kcsm.training.bootdemo.config;

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.service.Contact;
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 SwaggerConfiguration {


    @Bean
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGG