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

相关推荐
shehuiyuelaiyuehao6 小时前
1计算机是如何工作的
java·计算机网络
letisgo56 小时前
JAVA 高级进阶07篇《@Transactional失效的8个场景:代理机制到传播行为》
java·面试·transactional·spring事务·aop动态代理
水域安全老周6 小时前
水趣钓鱼救生衣专利拆解:两级锁紧如何解决落水人衣分离
java·前端·网络
新时代牛马7 小时前
cyclictest 毛刺从哪来?从ftrace、latencytop、perf到IRQ/调度延迟定位
android·开发语言·python·kotlin
三8447 小时前
Java 模板注入(FreeMarker) · 02 · 模板引擎与 FreeMarker 语法
java·开发语言·web安全·freemarker
IvanCodes7 小时前
Python 基础语法(七):推导式与常见遍历写法
开发语言·python
暮雨哀尘7 小时前
Java 基础练习(一):创建类并调用对象
java·开发语言
想要入门的程序猿7 小时前
回调函数学习
java·网络·学习
EatFan7 小时前
Java接入支付宝 JSAPI 支付保姆教程(二):流程讲解与前后端代码讲解
前端·spring boot·后端·微信小程序·小程序·uni-app
zhangzeyuaaa7 小时前
Python requests:raise_for_status() 与 4xx/5xx 异常层次详解
开发语言·python