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

相关推荐
暴力求解2 分钟前
C++ --- STL简介
开发语言·c++
Barkamin16 分钟前
多线程简单介绍
java·开发语言·jvm
小比特_蓝光40 分钟前
算法篇二----二分查找
java·数据结构·算法
QJtDK1R5a1 小时前
C# 14 中的新增功能
开发语言·c#
大黄说说1 小时前
Java 中 String 为何被设计为不可变?
开发语言
田梓燊1 小时前
leetcode 56
java·算法·leetcode
复园电子1 小时前
KVM与Hyper-V虚拟化环境:彻底解决USB外设映射掉线的底层架构优化
开发语言·架构·php
scan7241 小时前
龙虾读取session历史消息
java·前端·数据库
better_liang1 小时前
每日Java面试场景题知识点之-分布式事务
java·微服务·seata·分布式事务·一致性·saga·tcc
kvo7f2JTy1 小时前
JAVA 设计模式
java·开发语言·设计模式