Java编程技巧:swagger2、knif4j集成SpringBoot或者SpringCloud项目

目录

1、springboot+swagger2+knif4j

2、springboot+swagger3+knif4j

3、springcloud+swagger2+knif4j

注意点:

  1. @Api注解:Controller类上的@Api注解需要添加tags属性,否则在UI页面上无法正常显示中文描述信息,写法举例:@Api(value = "测试", tags = {"测试"})
  2. 尽量不使用Lombok的@Data注解来标注添加@ApiModel注解的类:该注解将导致swagger在处理字段名称为uId这种驼峰写法时,将在swagger或者knife4j的UI页面上显示uid,但是自己重写set和get方法就不会出现该问题。详细解释请看:swagger接口文档将部分参数转为错误格式驼峰命名
  3. 项目启动时出现Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPoi,这是由于springboot版本大于等于2.6.X了,大家可以降低springboot版本,也可以通过在application.yml中添加配置以及其他配置类方式来解决该问题(下面给出的demo项目使用该方式)。详细解释请看:解决方案之'Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPoi

说明: 不太想用代码来描述了,下面demo代码,大家可以自取

下载:

链接:https://pan.baidu.com/s/15FsOaMd0CUb4CSRnSG370g?pwd=vgl4

提取码:vgl4

项目结构截图:

swagger和knife4j访问地址信息在每个模块的说明文档.txt

相关推荐
南极星10052 分钟前
蓝桥杯JAVA--启蒙之路(十)class版本 模块
java·开发语言
消失的旧时光-19434 分钟前
第十三课:权限系统如何设计?——RBAC 与 Spring Security 架构
java·架构·spring security·rbac
baidu_247438616 分钟前
Android ViewModel定时任务
android·开发语言·javascript
Dev7z18 分钟前
基于 MATLAB 的铣削切削力建模与仿真
开发语言·matlab
不能隔夜的咖喱24 分钟前
牛客网刷题(2)
java·开发语言·算法
serve the people31 分钟前
python环境搭建 (十二) pydantic和pydantic-settings类型验证与解析
java·网络·python
小天源31 分钟前
Error 1053 Error 1067 服务“启动后立即停止” Java / Python 程序无法后台运行 windows nssm注册器下载与报错处理
开发语言·windows·python·nssm·error 1053·error 1067
lekami_兰1 小时前
Java 并发工具类详解:4 大核心工具 + 实战场景,告别 synchronized
java·并发工具
有位神秘人1 小时前
Android中Notification的使用详解
android·java·javascript
肉包_5111 小时前
两个数据库互锁,用全局变量互锁会偶发软件卡死
开发语言·数据库·c++