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

相关推荐
期待のcode28 分钟前
Spring框架1—Spring的IOC核心技术1
java·后端·spring·架构
鼠鼠我捏,要死了捏32 分钟前
Spring Boot Actuator自定义指标与监控实践指南
spring boot·监控·actuator
葵野寺36 分钟前
【RelayMQ】基于 Java 实现轻量级消息队列(七)
java·开发语言·网络·rabbitmq·java-rabbitmq
书院门前细致的苹果1 小时前
JVM 全面详解:深入理解 Java 的核心运行机制
java·jvm
上官浩仁1 小时前
springboot excel 表格入门与实战
java·spring boot·excel
zyx没烦恼1 小时前
Qt 基础编程核心知识点全解析:含 Hello World 实现、对象树、坐标系及开发工具使用
开发语言·qt
木心爱编程1 小时前
C++链表实战:STL与手动实现详解
开发语言·c++·链表
mkhase2 小时前
9.11-QT-QT的基本使用
开发语言·qt
Kyln.Wu2 小时前
【python实用小脚本-211】[硬件互联] 桌面壁纸×Python梦幻联动|用10行代码实现“开机盲盒”自动化改造实录(建议收藏)
开发语言·python·自动化
Hello.Reader2 小时前
从零到一上手 Protocol Buffers用 C# 打造可演进的通讯录
java·linux·c#