2021-08-23 bug记录 swagger接口文档将部分参数转为错误格式驼峰命名

最新推荐文章于 2024-04-25 11:07:48 发布
最新推荐文章于 2024-04-25 11:07:48 发布
阅读量752 收藏
点赞数 1
分类专栏： 坑 文章标签： java bug
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42345664/article/details/119867740
版权

问题描述：

在这里插入图片描述
swagger 生成的接口文档，会把大写变为小写【pName】,[pDesc] 改为 pname,pdesc

原因分析：

实体用@Data注解生成get/set，@Data会把属性首字母大写:getPName,getPDesc

swagger 不支持此类命名，会把大写转为小写
（ parentName getParentName 此类命名是支持转为parentName）

解决方案：

在此类属性上加@JsonProperty

Farmer宋
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
fiber-swagger:光纤中间件可通过Swagger 2.0自动生成RESTful API文档
05-15
光纤中间件，以使用Swagger 2.0自动生成RESTful API文档。 用法 开始使用它 将注释添加到您的API源代码中，。 使用以下方法下载 for Go： $ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的Go项目...
markdown-swagger：将Swagger文件中的API文档生成为markdown文件
02-04
将Swagger文件中的API文档生成为markdown文件。 安装 npm install markdown-swagger 用法 markdown-swagger ./api/swagger/swagger.yaml ./README.md 这将读取指定的swagger文件并生成一个表，该表描述目标markdown...
swagger 参数驼峰失效问题,Lombok
偷得浮生半日闲
11-30 2953
又是个网上搜索无果的问题，使用swagger生成的参数驼峰失效 先看问题 Java字段映射错误
Swagger入参显示问题
a20100997的博客
06-21 1719
今天发现了一个小问题，我写了一个post接口，入参用requestBody接收，但前端调用时发现有个参数接收不到，最后定位到是大小写的问题。我仔细查看swagger的接口文档，发现swagger存在bug：有一些参数我明明是驼峰命名，但是swagger却显示的和定义的不一致⬇️。经过搜索可能是lombok的@Data注解的问题，但代码已经写完，实在懒得改成getter和setter。
swagger接口文档生成后BUG，参数转换错误
最新发布
鱼儿锅头的博客
04-25 175
实体用@Data注解生成get/set，@Data会把属性首字母大写:getYCoord,getXCoord。swagger 对 apiModel的渲染没有展示Value等相应属性。在此类属性上加@JsonProperty，来灵活控制命名规则。swagger 不支持此类命名，会把大写转为小写。（ 需要的格式为：parentCoord ）
swagger部分字段无法展示中文描述问题
java_龙
01-15 490
import com.fasterxml.jackson.annotation.JsonProperty; @ApiModel("设备数据-属性值") @Data public class DetectC6DeviceDataContent { @ApiModelProperty("气象-风向") private String windDirect...
使用swagger时碰到的坑——次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题
极赫赫的博客
05-23 1199
本文主要是针对使用swagger时碰到的坑（次字母大写引起的注释部分丢失以及接口输出字段大小写不一致问题），进行分析与处理，需要的同学可以参考下。
JAVA对象jackson序列化json属性名首字母变成小写的解决方案
青青河边草
09-25 7757
默认情况下类的成员变量以小写字母开头,  当需要以大写开头时,系统在编译时或者swagger在传递参数时都会自动将大写变为小写,带来一些不便, 寻找后采取以下解决办法: 1. 解决swagger传递时的大写问题   @JsonProperty  //这个注解帮助实现大写传递     private String L1; //country;     @JsonProperty     priv...
hyperf-apihelper:hyperf api swagger helper -[api接口自动验证和swagger接口文档生成] 组件
05-08
hyperf-apihelperhyperf api and swagger helper....安装nginx(或apache)指定站点目录为 BASE_PATH/public, swagger-ui将自动发布到该目录下安装组件# composer安装本组件composer require kakuilan/hyperf-apihelper
springfox-swagger-common-3.0.0-API文档-中文版.zip
05-09
赠送jar包：springfox-swagger-common-3.0.0.jar； 赠送原API文档：springfox-swagger-common-3.0.0-javadoc.jar； 赠送源代码：springfox-swagger-common-3.0.0-sources.jar； 赠送Maven依赖信息文件：springfox-...
vscode-openapi-viewer:vsAPI的OpenAPI或swagger文档预览
05-17
OpenAPI文档查看器 查看器文档 该项目仍在进行中。 特征 使用预览文档API规范 使用摇头TODO验证文档OpenAPI规范 支持发送本机请求TODO 支持开关主题TODO 要求 用法 运行命令⇧⌘P的OpenAPI：预览。 第三方图书馆/...
swagger在传递参数时不改变属性大小写
t18092838767的博客
04-15 8014
并不是代码的问题，而是jackson的默认行为 默认情况下类的成员变量以小写字母开头, 当需要以大写开头时,系统在编译时或者swagger在传递参数时都会自动将大写变为小写,带来一些不便 解决方法就是： 1、在声明变量时加上注解： @JsonProperty 2、在set/get方法加上注解：@JsonIgnore ...
Lombok + Swagger2 +Jackson 属性第二个字母为大写，序列化后字段第二个字母为小写
u014212540的博客
10-09 620
原来SpringBoot 项目中采用的FastJson 转换器，配合Swagger2 + lombok 序列化后字段大小写正常，但是当换成fastJson 后，如果原来实体里面第二字母为大写则在swagger 文档里及接口返回的字段都给自动变为了小写。//1.需要定义一个convert转换消息的对象;//2:添加fastJson的配置信息;/**
记录:@JSONField和@JsonProperty和@ApiModelProperty一起使用，swagger显示不正常
weixin_39309402的博客
12-03 2089
@JSONField(name = "C-API-Status") @JsonProperty("C-API-Status") @ApiModelProperty(value = "响应码") private String CApiStatus; @JSONField(name = "C-Response-Code") @JsonProperty("C-Response-Code") @ApiModelProperty(value = "888888") private String CResp.
swagger 解决文档大写变小写
西柚2015地信小白GISer
12-21 2813
添加位置截图 复制内容: services.AddControllers().AddJsonOptions(config => { //解决文档中样例参数说明中参数首字母变小写的问题 config.JsonSerializerOptions.PropertyNamingPolicy = null; }); ...
springboot项目中实体字段第二个不要用大写
weixin_52777458的博客
07-14 786
实体字段第二个字符不要用大写
springBoot整合mybatis-plus关闭自动转换小驼峰命名规则
weixin_45761608的博客
01-17 1359
增加配置信息 mybatis-plus: configuration: map-underscore-to-camel-case: false
使用Newtonsoft.Json导致Swagger展示的属性名称错误
The Shio的博客
07-13 353
我在代码中写了取消驼峰命名发的代码，但是在Swagger中，发现展示的数据竟然还是小写开头，但是返回的数据却没有问题。下方为接口传入实体 我明确设置了取消使用驼峰命名法序列化实体 但是swagger页面中的展示的Json竟然还是按照驼峰命名法输出的 2.解决方案 需要安装额外的包微软在发布DotNet 3.0以后,推出了关于Json序列化的类库:正式因为这个类库的加入,Swagger们开始转向使用原生支持,如果你使用了Newtonsoft.Json来做为序列化的工具,就需要安装上方解决方案中的类库。线索出自
驼峰转换下划线 下划线转换驼峰
kouhunzhe的博客
06-28 800
// 驼峰转换下划线 function toLine(name) { return name.replace(/([A-Z])/g, "_$1").toLowerCase(); } // 下划线转换驼峰 function toLowerLine(str){ // eslint-disable-next-line no-useless-escape str = str.replace(/\_(\w)/g, function (all, letter) { return letter.to.
用swagger-maven-plugin生成接口文档swagger.json或者swagger.yaml
03-20
Swagger Maven Plugin是一个用于生成Swagger接口文档的Maven插件。它可以帮助开发人员在构建项目时自动生成Swagger规范的JSON或YAML文件，以便于API文档的管理和使用。 使用Swagger Maven Plugin生成接口文档swagger.json或swagger.yaml的步骤如下： 1. 在项目的pom.xml文件中添加Swagger Maven Plugin的依赖配置： ```xml <build> <plugins> <plugin> <groupId>com.github.kongchen</groupId> <artifactId>swagger-maven-plugin</artifactId> <version>3.1.8</version> <configuration> <!-- 配置Swagger文档的基本信息 --> <apiSources> <apiSource> <springmvc>true</springmvc> <locations>com.example.controller</locations> <basePath>/api</basePath> <info> <title>API文档</title> <version>1.0.0</version> <description>API接口文档</description> <termsOfServiceUrl>http://example.com/terms-of-service</termsOfServiceUrl> <contact> <email>contact@example.com</email> </contact> <license> <name>Apache 2.0</name> <url>http://www.apache.org/licenses/LICENSE-2.0.html</url> </license> </info> </apiSource> </apiSources> </configuration> <executions> <execution> <phase>compile</phase> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> </plugins> </build> ``` 2. 在项目根目录下执行以下命令生成Swagger接口文档： ``` mvn compile swagger:generate ``` 3. 执行完上述命令后，Swagger Maven Plugin会根据配置的信息扫描项目中的接口，并生成Swagger规范的JSON或YAML文件。生成的文件默认保存在项目的target目录下的swagger目录中。 生成的Swagger接口文档可以通过访问http://localhost:8080/api/swagger-ui.html（假设项目部署在本地的8080端口）来查看和测试API接口。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值