knife4j的引入

目录

一、knife4j是什么？

二、使用步骤

1.通过再pom中引入Knife4j的依赖

官网地址Knife4j官网

2.在配置类中加入注解

---

一、knife4j是什么？

Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目。后来因为原作者希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端，所以更名为Knife4j。简单来说，knife4j就是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

二、使用步骤

1.通过在pom中引入Knife4j的依赖

代码如下（示例）：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索2.X最新版本号-->
    <version>2.0.4</version>
</dependency>

官网地址Knife4j官网

具体版本的引入和不同框架下的需求请到官网文档中查看，比如目前已经发行的Knife4j版本，Knife4j本身已经引入了springfox，开发者在使用时不用再单独引入Springfox的具体版本，否额会导致版本冲突。另外在网关层聚合(例如gateway)时，必须禁用Knife4j的增强模式

2.在配置类中加入注解

在Swagger2Config中增加一个@EnableKnife4j注解，该注解可以开启knife4j的增强功能：

/**
 * Swagger2API文档的配置
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class Swagger2Config {
    
}

然后访问http://localhost:+你的端口号+/doc.html就可以访问自己的api文档。

可以看到

---

 比起原生的swagger，引入Knife4j后功能更加强大与便捷