技术栈
版本
说明
java
≥17.0.2
JDK版本
springframework
6.1.11
JavaEE开发框架
springboot
3.3.2
容器+MVC框架
gradle
8.9
自动化构建工具
lombok
1.18.32
Java工具类库
knife4j
4.5.0
Swagger增强组件
前提还是需要具备JAVA开发的基础概念,比如安装JDK环境。
1. 创建空项目
使用 Spring Initializr 「https://start.spring.io/」快速创建Spring项目
在 Dependencies 对话框中搜索并添加 web 依赖关系,如屏幕截图所示。点击“生成”按钮,下载压缩包,并将其解压缩到计算机本地。
Spring Initializr
2. 编写基础的 Gradle 相关脚本
以下按相对项目的根目录进行说明,如文件不存在 可以手动创建:gradle.properties
build.gradle
3. 创建 Springboot 启动类
com.app4j.web.WebApplication
ok 项目这就可以正式启动啦!
项目启动效果
4. 整合 Swagger
只需一步即可!引入 Knife4j Swagger 增加工具包:
让我们添加一个接口,测试下 swagger 的效果:
访问接口文档的本地地址:http://127.0.0.1:8080/doc.html
Swagger 界面效果
重要提示:为什么这次不用配置Docket Bean,就可以看到接口清单?
Knife4j 自4.0版本,下面的配置在 knife4j-openapi2-spring-boot-starter 中仍然需要如此配置,而在 knife4j-openapi3-spring-boot-starter 和 knife4j-openapi3-jakarta-spring-boot-starter 则不需要!!!
Knife4j 版本说明
以上,我们完成了一个新的网站项目的初始化,并查看网站项目的OpenAPI!
关注点赞收藏不迷路!!振锁会持续给大家分享大厂一线的开发经验,手把手从0到架构设计!成为独当一面的多面手!!
发表评论