更换原因

swagger-ui官方ui不太符合国内审美,丑、功能少不好用

开源代码:https://gitee.com/xiaoym/knife4j

更换步骤

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

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

  1. <dependency>
  2. <groupId>com.github.xiaoymin</groupId>
  3. <artifactId>knife4j-spring-ui</artifactId>
  4. <version>${lastVersion}</version>
  5. </dependency>

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

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

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

  1. <dependency>
  2. <groupId>com.github.xiaoymin</groupId>
  3. <artifactId>knife4j-spring-boot-starter</artifactId>
  4. <version>${knife4j.version}</version>
  5. </dependency>

Spring Cloud微服务架构

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

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

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

  1. <dependency>
  2. <groupId>com.github.xiaoymin</groupId>
  3. <artifactId>knife4j-spring-boot-starter</artifactId>
  4. <version>${knife4j.version}</version>
  5. </dependency>


然后访问:http://ip:port/doc.html

示例

示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

模块名称 说明
knife4j 为Java MVC框架集成Swagger的增强解决方案
knife4j-admin 云端Swagger接口文档注册管理中心,集成gateway网关对任意微服务文档进行组合集成
knife4j-extension chrome浏览器的增强swagger接口文档ui,快速渲染swagger资源
knife4j-service 为swagger服务的一系列接口服务程序
knife4j-front knife4j-spring-ui的纯前端静态版本,用于集成非Java语言使用
swagger-bootstrap-ui knife4j的前身,最后发布版本是1.9.6