使用swagger时碰到的坑——次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题

问题场景

最近项目在对接前端的时候发现这么个问题,项目使用swagger2后,生成的文档部分注释是为空的问题。
使用swagger时碰到的坑——次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题_第1张图片

解决方案

1、起初是因为着急对接好接口进行测试,所以手动把类编写成文档提供给前端了。
2、后面发现一个问题就是文档的注释和接口大小写不一致。
后续在排查的时候,发现接口凡是次字母是大写的字段,注释以及接口返回就变成了小写形式,同时注释也显示不出来。
这边由于文档提供的原因,许多如 b_allast_pumpInlet_press 这样的字段,后端在处理的时候都是改成bAllastPumpInletPress
进行保存了,但是swagger2注释添加后,接口输出又变成了ballastPumpInletPress 格式。
3、找到问题后,就是依次对次字母为大写的字段名都做了调整。接口字段注释以及大小写输出问题也就解决了。
使用swagger时碰到的坑——次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题_第2张图片

尾言

通过这次踩坑,后续命名时习惯也会相应调整,感谢阅读。

你可能感兴趣的:(后端的路,BUG++,java)