swagger-ui升级为knife的过程记录

1.什么是knife4j

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案（在非Java项目中也提供了前端UI的增强解决方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍! 官方网址入口knife4j码云地址，knife4j的git地址

2.knife4j的优点

• 简洁
  基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰…

• 个性化配置
  个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能…

• 增强
  接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能…

• 功能预览
  http://knife4j.xiaominfo.com/doc.html

• 离线文档导出
  Knife4j提供导出4种格式的离线文档(Html\Markdown\Word\openApi）

3.使用说明

3.1 不使用增强功能,纯粹换一个swagger的前端皮肤

不使用增强功能,纯粹换一个swagger的前端皮肤，这种情况是最简单的,你项目结构下无需变更
可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui

• 老版本引用

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

• 新版本引用

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-ui</artifactId>
    <version>${lastVersion}</version>
</dependency>

3.2 Spring Boot项目单体架构使用增强功能

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用

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

该包会引用所有的knife4j提供的资源，包括前端Ui的jar包

3.3 Spring Cloud微服务架构

在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-micro-spring-boot-starter</artifactId>
    <version>${knife4j.version}</version>
</dependency>

在网关聚合文档服务下,可以再把前端的ui资源引入

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

4.验证网址

http://{ip}:{port}/doc.html

5.总结

knife4j解决就swagger的界面不好看，导出接口文档功能不友好相关的问题。总结起来就是真香