Swagger 大坑 之 @ApiModelProperty 注解的大坑
创始人
2025-05-29 01:22:28

Swagger页面上突然少了一个接口集;@ApiModelProperty注解是不能修饰public修饰的类属性的

一、注解介绍:
@ApiModelProperty注解 是一个用来标注类属性的注解

它常用的属性有如下几个

1、name:重写属性名。

2、value:属性的中文描述。

3、dataType:重写属性类型。

4、required:是否必须。

5、example:举例说明。

6、hidden:隐藏。

二、问题发现:
我们项目中使用到了swagger,正常使用模块有两个如下图:
在这里插入图片描述
但是在开发过程中,一天重启项目突然发现少了一个接口集:业务模块。
项目启动报错如下图:
请添加图片描述
意思是,空指针致使扫描不到业务模块接口集到文档中。

三、问题解决:
1、在度娘上寻找相同的问题,未果。
2、通过对比代码,排查最近两天自己的操作。果然在一个实体类中发现了异常如下图:
在这里插入图片描述
我发现这个属性,我之前测试的时候改成public了,等我改回private神奇的发现好了,于是我去网上寻找这个注解是否可以放在public修饰的属性上。
然后未果,一堆关于ApiModelProperty注解,无关的帖子弹出来。
总结出来:@ApiModelProperty注解是不能修饰public修饰的类属性的。
然后我就记了下来,发到网上,希望能够帮助大家。

每日一语:但行好事,莫问前程。

相关内容

热门资讯

记者手记|时代大潮里的笃行与担... 来源:新华社记者手记|时代大潮里的笃行与担当新华社记者韩梁 朱瑞卿 伍岳9月的新德里草木葱郁,阳光热...
被骂 “君子之贼” 高若讷有点...     ◎宋慧敏    北宋景祐三年(1036年)一个春日,谏官高若讷接到一封信,写信人是刚刚入朝任...
烂缦胡同:烟火气里涌动青春创业...     近日,在“全国文化中心建设巡礼”主题采访活动中,北京青年报记者走进北京市西城区牛街街道烂缦胡...
科技赋能实体 金融护航出海     9月9日至13日,2026年中国国际服务贸易交易会(以下简称服贸会)在北京首钢园举办,今年的...
湖北大学最新或2023(历届)...   1、考生自最新或2023(历届)4月1日起可在湖北大学招生信息网(http://zsxx.hub...