Swagger 大坑 之 @ApiModelProperty 注解的大坑

这篇具有很好参考价值的文章主要介绍了Swagger 大坑 之 @ApiModelProperty 注解的大坑。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

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

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

它常用的属性有如下几个

1、name:重写属性名。

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

3、dataType:重写属性类型。

4、required:是否必须。

5、example:举例说明。

6、hidden:隐藏。

二、问题发现:
我们项目中使用到了swagger,正常使用模块有两个如下图:
apimodel注解,工作报错纪要,java,spring,开发语言,swagger
但是在开发过程中,一天重启项目突然发现少了一个接口集:业务模块。
项目启动报错如下图:
apimodel注解,工作报错纪要,java,spring,开发语言,swagger
意思是,空指针致使扫描不到业务模块接口集到文档中。

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

每日一语:但行好事,莫问前程。文章来源地址https://www.toymoban.com/news/detail-620534.html

到了这里,关于Swagger 大坑 之 @ApiModelProperty 注解的大坑的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【Swagger】常用注解的使用、SpringBoot的整合及生产环境下屏蔽Swagger

            Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。它使得部署管理和使用功能强大的API从未如此简单。Swagger让文件的方法、参数和模型紧密集成到服务器端的代码,允许API始终保持同步。 在软件开发中,常用注解(Annotation)主

    2024年02月03日
    浏览(38)
  • Maven编译时,如何忽略swagger注解

    在Javabean中,@ApiModelProperty这种swagger注解,只是为了在开发时生成API文档;     在放到生产环境时,是不需要的。有什么方法,可以在为生产环境编译jar时,忽略这些swagger注解吗? 有知道的大神吗?  请留言,谢谢!

    2024年02月01日
    浏览(50)
  • 勇敢尝鲜之Springboot3大坑-集成Mybatisplus报错:ddlApplicationRunner

    🌹作者主页:青花锁 🌹简介:Java领域优质创作者🏆、Java微服务架构公号作者😄 🌹简历模板、学习资料、面试题库、技术互助 🌹文末获取联系方式 📝 专栏 描述 Java项目实战 介绍Java组件安装、使用;手写框架等 Aws服务器实战 Aws Linux服务器上操作nginx、git、JDK、Vue Jav

    2024年03月15日
    浏览(47)
  • SpringBoot项目中使用Swagger2及注解解释(详细)

    SpringBoot项目中使用Swagger2及注解解释 一、导入Swagger坐标依赖 其中版本最常用2.9.2 二、在spring启动类添加注解@EnableSwagger2 @EnableSwagger2是springfox提供的一个注解,代表swagger2相关技术开启。会扫描当前类所在包,及子包中所有类型的swagger相关注解,做swagger文档的定制 三、启动

    2023年04月18日
    浏览(80)
  • springboot 集成 Swagger2 配置以及常用注解的说明和使用 ( 超详细)

    一、注解的使用 和 说明 结构化说明如下: @Api:用在请求的类上,表示对类的说明      tags=\\\"说明该类的作用,可以在UI界面上看到的注解\\\"    (也就是给类取别名)     value=\\\"该参数没什么意义,在UI界面上也看到,所以不需要配置\\\"    @ApiOperation:用在请求的方法上,说

    2024年02月03日
    浏览(44)
  • Swagger配置报错的原因

    An error occurred while starting the application. AggregateException: Some services are not able to be constructed (Error while validating the service descriptor ‘ServiceType: Swashbuckle.AspNetCore.Swagger.ISwaggerProvider Lifetime: Transient ImplementationType: Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator’: No constructor for type ‘Swashbuckle.

    2024年02月10日
    浏览(40)
  • Springboot整合Swagger2后访问swagger-ui.html 404报错

    在spring boot项目中配置Swagger2,配置好了但是访问确实404,SwaggerConfig中的注入方法也执行了还是访问不到页面。究其原因是MVC没有找到swagger-ui包中的swagger-ui.html文件和css样式、js等文件。 解决⽅案: ⽅案1. 降低Swagger2的使用版本 ⽅案2. 使⽤配置⼀下+swagger-ui.html+指定的css⽬录

    2024年02月11日
    浏览(37)
  • 【JAVA swagger】解决No mapping for GET /swagger-ui.html报错

    完整代码在最后 一、报错 1.网页报错404 2.代码报错 No mapping for GET /swagger-ui.html 二、解决办法 1.版本回退 之前用的是swagger3.0.0和springboot3.0.6,始终没找到合适的解决办法,故将版本回退至swagger2.9.2和springboot2.7.11 2.Spring Boot 2.6.X后与Swagger有版本冲突问题,需要在application.prope

    2024年02月11日
    浏览(51)
  • SpringBoot整合Swagger踩坑-项目启动报错与swagger-ui.html请求404无法访问

    依赖 常见依赖接入方式如下: springfox推荐 依赖接入方式如下: 建议使用推荐的方式,可以协助我们解决404异常的问题。 配置 依赖导入完成后创建 SwaggerConfig.java 配置: 报错信息: org.springframework.context.ApplicationContextException: Failed to start bean ‘documentationPluginsBootstrapper’; n

    2024年02月01日
    浏览(37)
  • java中swagger报错:Please indicate a valid Swagger or OpenAPI version field. Supported version fields ar

    请先看图,是不是和你所遇到的问题一致:  既然你搜索到这个错误问题,应该其它swagger基本配置都已做好了,那么这个错误信息已经提示你了,也给你标记出来了,请选择版本 一个是 swagger 它是 2.0的,另一个是 openapi 它是3.0的,那么你要看下你目前选择的是哪个:

    2024年02月12日
    浏览(38)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包