SpringBoot集成Knife4j（Swagger-Bootstrap-UI），页面更清爽！

简介

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案，前身是swagger-bootstrap-ui

官网：https://gitee.com/xiaoym/knife4j

• 前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活
• 提供专注于Swagger的增强解决方案，不同于只是改善增强前端Ui部分
• 官方文档：https://doc.xiaominfo.com/knife4j/documentation/
• 备份文档地址：https://xiaoym.gitee.io/knife4j/
• 效果(2.0版)：http://knife4j.xiaominfo.com/doc.html
• 效果(旧版本)：http://swagger-bootstrap-ui.xiaominfo.com/doc.html
• 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

集成

不使用增强功能，纯粹换一个swagger的前端皮肤，这种情况是最简单的，你项目结构下无需变更

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

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包

在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>

另外说明

不管是knife4j还是swagger-bootstrap-ui，对外提供的地址依然是doc.html

访问：http://ip:port/doc.html，即可查看文档