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

相关推荐
鸡吃丸子8 分钟前
Next.js 入门指南
开发语言·javascript·next.js
wjs202412 分钟前
《Foundation 滑块:界面设计的艺术与科学》
开发语言
Aevget29 分钟前
「Java EE开发指南」用MyEclipse开发的EJB开发工具(二)
java·ide·java-ee·eclipse·myeclipse
黄昏晓x35 分钟前
C++----多态
java·jvm·c++
William_cl42 分钟前
【C# OOP 入门到精通】从基础概念到 MVC 实战(含 SOLID 原则与完整代码)
开发语言·c#·mvc
Brookty44 分钟前
【算法】前缀和
java·学习·算法·前缀和·动态规划
少许极端1 小时前
算法奇妙屋(七)-字符串操作
java·开发语言·数据结构·算法·字符串操作
懒羊羊不懒@2 小时前
Java基础语法—字面量、变量详解、存储数据原理
java·开发语言
望获linux2 小时前
【实时Linux实战系列】实时 Linux 的自动化基准测试框架
java·大数据·linux·运维·网络·elasticsearch·搜索引擎
Code blocks2 小时前
GB28181视频服务wvp部署(一)
java·spring boot·后端