Knife4j 基础使用教程
1、前言
特别注意
如何没有特别标注说明,本文默认使用的 Knife4j 版本是 2.x
。
1.1、Knife4j 简介
Knife4j 是为 Java MVC 框架集成 Swagger 生成 Api 文档的增强解决方案,前身是 swagger-bootstrap-ui
,致力于 springfox-swagger
的增强 UI 实现。knife4j 为了契合微服务的架构发展,由于原来 swagger-bootstrap-ui
采用的是后端 Java 代码 + 前端 UI 混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为 knife4j,更名后主要专注的方面如下:
- 后端 Java 代码以及前端 UI 模块进行了分离,在微服务架构下使用更加灵活
- 提供专注于 Swagger 的增强解决方案,不同于只是单纯增强前端 UI 部分
1.2、Knife4j 模块
模块名称 | 说明 |
---|---|
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 |