swagger学习日记4 文档无法识别下划线属性名

太过爱你忘了你带给我的痛 2022-11-03 04:27 11阅读 0赞

# 问题分析： #

今天在使用swagger注解接口，编写文档的时候，发现了一个大问题：如何在让swagger文档识别带下划线（\_）的属性名？如：

{
    	"account_name": "nspd1",
    	"password": "zg=="
    }

--------------------

# 问题现象： #

查看了网上资料发现，并没有该问题的解决方法，有的都是在说如何解决Map数据类型的子属性注解问题。

于是我就开始自己尝试：

1.当我使用网上大神么的创建新注解的方法时注解Map数据类型的对象时，确实可以解决这个问题：

当也有很大局限性，固定的Map格式注解，是不适用于其他数据模型的情况的，例如：像下面这种（嵌套Map）数据模型，就很复杂，我在网上没有找到这种数据模型的注解实现方法：

{
    	"reply": {
    		"code": 1000,
    		"msg": "成功"
    	},
    	"result": {
    		"user_id": ""
    	}
    }

2.然后自己也是刚接触swagger不久，没有怎么了解过深层逻辑代码，所以只能使用**最基本但也是最简单的方法**，就是利用把**实体类注解 @ApiModel** 和 **实体类属性注解 @ApiModelProperty，即可实现；**

### **3.回到最开始的问题：**如何在让swagger文档识别带下划线（\_）的属性名？ ###

**我试过把实体类的属性从正规的小驼峰，改为下划线格式，但还是不行，swagger文档还是识别成了小驼峰格式**

后来通过思考，终于想起来一个经常忘记的知识点：从上面的尝试中，可以知道，对属性名格式的识别其实和属性名无关，至此我终于想起来是和getter、setter方法有关，

于是修改了setter/getter 方法之后终于可以了；

--------------------

# 解决方法： #

1.先把属性名修改为带下划线的格式，

2.在IDEA中可以按快捷键 alt + Insert 快速生成getter/setter方法即可

**注意：其实带下划线是不符合前后端数据交互和开发规范的，但由于本项目是老旧的项目，所以也是挺无奈的，这里还是建议尽量不要使用下划线。**

发表评论取消回复

表情：

评论列表（有 0 条评论，11人围观）

还没有评论，来说两句吧...

相关阅读

相关 MySQL学习日记4

MySQL学习日记4 视图 1. 视图的定义视图是一个**虚表**，是从数据库中一个或者多个表中导出来的表。视图还可以从已经存在的视图的基础上定义。 ...

矫情吗；*/ 2024年04月17日 05:42/ 0 赞/ 72 阅读

相关（knife4j）Swagger-JAVAapi文档生成器

一、使用 1、导入knife4j的maven坐标 <dependency> <groupId>com.github.xiaoymin</gr

忘是亡心i/ 2023年10月09日 15:23/ 0 赞/ 60 阅读

相关 knife4j 美化 swagger 文档

文章目录一、导包二、knife4j 配置三、swagger 配置

叁歲伎倆/ 2023年09月24日 12:39/ 0 赞/ 151 阅读

相关 Dapr学习日记4

1.Dapr服务发现解析：Kubernetes名称解析组件使用Kubernetes DNS服务来解析在集群中运行的其它应用程序的位置。 2.自托管模式解析：在自托

谁借莪１个温暖的怀抱￠/ 2023年01月23日 12:49/ 0 赞/ 32 阅读

相关制造业学习日记4

1.APS解决的问题解析： \[1\]离散行业：APS是为解决多工序、多资源的优化调度问题 \[2\]流程行业：APS是为解决顺序优化问题 \[3\]流程+离

蔚落/ 2023年01月21日 02:29/ 0 赞/ 98 阅读

相关 Swagger文档无法生成部分实体类

原因低版本的spring-web(小于5.1.0-RELEASE)， HandlerMethodParameter没有重写getParameterAnnotations

素颜马尾好姑娘i/ 2022年11月11日 13:28/ 0 赞/ 231 阅读

相关 swagger学习日记4 文档无法识别下划线属性名

问题分析：今天在使用swagger注解接口，编写文档的时候，发现了一个大问题：如何在让swagger文档识别带下划线（\_）的属性名？如： { "a

太过爱你忘了你带给我的痛/ 2022年11月03日 04:27/ 0 赞/ 12 阅读

相关 Swagger文档 --

作用：Swagger是一个规范和完整的框架，用于生成，描述，调用和可视化RestFul风格的Web服务，主要用于接口文档的在线自动生成，功能测试。 Maven： <

冷不防/ 2022年05月16日 15:24/ 0 赞/ 216 阅读

相关 zookeeper启动报主机名无法识别

一:Bug截图 zookeeper启动报主机名无法识别 java.net.UnknownHostException 二:原因分析 1:本地hosts文件没有配置 ![

淩亂°似流年/ 2022年02月16日 23:47/ 0 赞/ 471 阅读

相关 Swagger无法打开API详情文档的问题

Swagger是目前很流行的API文档，随便去github上翻一翻别人的项目（唯品会分布式调度平台Saturn、开源BI工具Davinci等），都加入了Swagger来管理。它

逃离我推掉我的手/ 2021年10月15日 01:53/ 0 赞/ 594 阅读