Spring Boot+WebFlux项目OpenAPI生成Schema时同字段重复如何解决
问题根源
Kotlin 数据类的属性注解默认作用于构造函数参数,Jackson 和 springdoc 会同时扫描构造参数注解、生成的类字段、getter 方法三个位置的属性配置,你当前的注解没有指定作用目标,导致框架同时识别到构造参数上指定的tenant_id别名,和 getter 对应的原生驼峰字段名tenantId,最终生成重复的 Schema 字段。
解决方案
场景1:仅个别字段需要自定义序列化名称
给字段的所有注解添加@get:前缀,指定注解作用于 getter 方法即可,修正后的字段代码如下:
@Column("tenant_id") @get:JsonProperty("tenant_id", required = true) @get:Pattern(regexp = "^[0-9]{5}\$") @get:Schema(description = "The ID of the Tenant", example = "12345") val tenantId: String,
不需要在@Schema中单独指定name属性,框架会自动读取@JsonProperty的配置作为字段名。
场景2:项目全局统一使用驼峰转蛇形命名
如果你的项目所有接口字段都统一用蛇形命名,不需要单独给每个字段加@JsonProperty,直接加全局配置即可:
- application.yml 添加如下配置:
spring: jackson: property-naming-strategy: SNAKE_CASE springdoc: default-model-property-naming-strategy: SNAKE_CASE
- 删掉模型字段上的
@JsonProperty("tenant_id")和@Schema(name = "tenant_id")注解,框架会自动把驼峰属性tenantId转为蛇形的tenant_id生成 Schema,不会出现重复字段。
内容的提问来源于stack exchange,提问作者dim
相关产品推荐
相关产品推荐

