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

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

相关内容

热门资讯

我国计划到2027年建成一批具... 来源:新华社新华社记者 高亢国家数据局近日发布《国家数据局关于加强数据科技创新的实施意见》。意见明确...
打破保险营销惯性,看中国人寿如... “突然感觉我需要规划一下我的生活。”这是詹青云做客中国人寿《保险夜话小馆?去她家吧》的高赞评论之一。...
11年破三关:一粒中国稻种如何... 每经记者|郑雨航    每经编辑|王嘉琦 高涵     11月的尼日利亚首都阿布贾...
中药注射剂红利退潮,悦康药业“... 12月初,悦康药业公告筹划发行H股并在香港联交所主板上市,试图打开新的融资通道。这家2020年登陆科...
你常去的苏式面馆里,可能藏着“... 转自:扬子晚报当百年苏面遇上当代艺术,当地铁出行变成一趟文艺之旅,会碰撞出怎样的火花?12月27日下...