Hello,大家好,我是Feri,一枚十多年的程序员,同时也是一名在读研究生,关注我,且看一个平凡的程序员如何在自我成长,CodingSir是我想打造一个编程社区,只为各位小伙伴提供编程相关干货知识,希望在自我蜕变的路上,我们一起努力,努力什么时候开始都不晚,我,从现在开始做起!
一、前言
最近写了几篇关于最新版SpringBoot使用的教程,我看有小伙伴私信就是想要了解一下SpringBoot新版本怎么整合接口文档框架,因为之前都是使用Swagger,但是这个有点旧,那么本篇安排上。
通过SpringBoot3.3.4版本整合目前主流的接口文档框架Knife4j的新版本,因为SpringBoot3只支持OpenAI3规范,所以本篇是通过整合Knife4j的4.4版本进行演示接口文档框架的应用。
注意:jdk至少>=17哈,别问为什么,问了就告诉你!
二、实现
2.1 Swagger
Swagger(丝袜哥)呢,是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。
Swagger官网地址:https://swagger.io/
2.2 Knife4j
Knife4j是一个集Swagger2和OpenAPI3为一体的增强解决方案,帮助开发者快速聚合使用OpenAPI规范。更名为Knife4j之前,原来的名称是叫swagger-bootstrap-ui,而swagger-bootstrap-ui是原来对swagger-ui的优化,比之更加好看一些。
Knife4j官网地址:Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j
Knife4j v4.0架构图:
Knife4j的版本历史: