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修饰的类属性的。
然后我就记了下来，发到网上，希望能够帮助大家。

每日一语：但行好事，莫问前程。

上一篇：曹操最想得到的武将是谁？是关羽吗 曹操和关羽哪个武将最厉害 曹操得到关羽

下一篇：明朝最富有的太监，还被评为近几百年最富有的五十人之一，最后被凌迟3357刀而死 明朝最富有的太监，还被评为近几百年最富有的五十人之一，最后被凌迟3357刀而死

相关内容

热门资讯

四川最新或2023（历届）高校... 行虚假招生宣传；不得在高考前以任何形式组织与自主招生挂钩的考核工作；高校自主招生工作人员、专家评委不...
四川最新或2023（历届）高校... 姓名、性别、所在中学（或单位）、享受照顾政策类别、资格条件、测试项目、测试成绩、合格标准、拟录高校及...
最新或2023（历届）四川高校... 相关高校做好向社会和考生的宣传工作
最新或2023（历届）四川高校... 、确认考生报名信息，试点高校须于4月30日前将确定参加学校考核的我省考生名单及学校联系方式函报我院；...
四川最新或2023（历届）高校... 究相关责任。　　请各地招考办和相关高校做好向社会和考生的宣传工作。