[BUG] [Java/Spring/Spring-Boot] @JsonProperty is missing on setters / deserialization problems using SpringBoot4 with field xRequestId

[WennySoft]

Bug Report Checklist

• Have you provided a full/minimal spec to reproduce the issue?
• Have you validated the input using an OpenAPI validator?
• Have you tested with the latest master to confirm the issue still exists?
• Have you searched for related issues/PRs?
• What's the actual output vs expected output?
• [Optional] Sponsorship to speed up the bug fix or feature request (example)

Description

problem;
When generating modles with spring/spring-boot jacksons annotations @JsonProperty are put only on the getters. On deserializing jackson needs them at the setters to take place. Without them the default mapping is used.

Until SpringBoot 3 this worked for a property (not header) 'xRequestId' but with SpringBoot 4 the default behaviour changed and valid requests are not validated anymore as the xRequestId is left null after deserializing

suggested fix
add the JsonProperty annotations also on the setters. I did this by modifying the template pojo.mustache (from master) and this works

openapi-generator version

7.17.0 and 7.19.0

OpenAPI declaration file content or url

openapi: 3.1.0
info:
  title: dummy api
  description: Simple Spec to show problem
  version: 0.0.0
components:
  schemas:
    someObj:
      type: object
      required:
        - xRequestId
      properties:
        xRequestId:
          type: string
          example: "9f09113b-1f95-4c8a-b90a-c5bf6c35c4d9"
          format: uuid

Generation Details

Generated using maven

            <plugin>
                <groupId>org.openapitools</groupId>
                <artifactId>openapi-generator-maven-plugin</artifactId>
                <version>7.19.0</version>
                <configuration>
                    <generatorName>spring</generatorName>
                    <library>spring-boot</library>
                    <configOptions>
                        <useSpringBoot3>true</useSpringBoot3>
                        <useJakartaEee>true</useJakartaEee>
                    </configOptions>
                    <inputSpec>simple-api.yml</inputSpec>
                </configuration>
                <executions>
                    <execution>
                        <id>generate-txdata</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

lead to

 /**
   * Get xRequestId
   * @return xRequestId
   */
  @NotNull @Valid 
  @Schema(name = "xRequestId", example = "9f09113b-1f95-4c8a-b90a-c5bf6c35c4d9", requiredMode = Schema.RequiredMode.REQUIRED)
  @JsonProperty("xRequestId")
  public UUID getxRequestId() {
    return xRequestId;
  }

  public void setxRequestId(UUID xRequestId) {
    this.xRequestId = xRequestId;
  }

note the missing @JsonProperty on setxRequestId

I assume that the default change is regarding 1 lower letter followed directly by 1 upper letter on property name

Steps to reproduce

Take the given api and generate the code with the plugin configuration above

Related issues/PRs

There seemed to be a fix in the past

• [Java] add jackson annotations to setters #9041
• [REQ][JAVA]: Include @JsonProperty to fields in java model class when @lombok.Data is used with Jackson (serializationLibrary) #19743

Suggest a fix

Copy jackson config from getters to setters in https://github.com/OpenAPITools/openapi-generator/blob/342febde58e655953a697320f30dd1febdf09ef5/modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache

[jpfinne]

@WennySoft This is very annoying with the spring generator. Jackson2 and Jackson3 behave differently when processing @JsonProperty on getters/setters

I don't remember why there is no @JsonProperty on setter, maybe related to inheritance? Can anyone explain?

There are several workarounds:

Use a custom pojo template with the additional @JsonProperty annotation on setters (your suggestion)

Use a custom pojo template with the additional `@JsonProperty on constructor (see restclient/pojo.mustache Constructor with all args parameters)

Add x-field-extra-annotation: '@JsonProperty("xRequestId")' or x-setter-extra-annotation: '@JsonProperty("xRequestId")' in the OpenAPI file.

Define a custom ValueDeserializer (complex!)

  @JacksonComponent
  public class SomeObjPatch {

      public static class Deserializer extends ValueDeserializer<SomeObj> {

          @Override
          public SomeObj deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException {
              TreeNode treeNode = p.readValueAsTree();
              StringNode xRequestId = (StringNode)treeNode.get("xRequestId");
              return new SomeObj().xRequestId(xRequestId != null? UUID.fromString(xRequestId.asString()) : null);
          }
      }
  }

Use the java restclient generator for the models. It generates @JsonProperty annotations on setters and on allArgsConstructor arguments. It is possible to use the java generator for the model and the spring generator for the api.

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>7.19.0</version>
    <configuration>
        <inputSpec>simple-api.yml</inputSpec>
    </configuration>
    <executions>
        <execution>
            <id>generate-model</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <generatorName>java</generatorName>
                <library>restclient</library>
                <generateApis>false</generateApis>
                <modelPackage>org.openapitools.model</modelPackage>
                <configOptions>
                    <generateConstructorWithAllArgs>true</generateConstructorWithAllArgs>
                    <useJakartaEee>true</useJakartaEee>
                </configOptions>
            </configuration>
        </execution>

        <execution>
            <id>generate-api</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <generatorName>spring</generatorName>
                <library>spring-boot</library>
                <configOptions>
                    <useSpringBoot3>true</useSpringBoot3>
                    <useJakartaEee>true</useJakartaEee>
                </configOptions>
            </configuration>
        </execution>
    </executions>
</plugin>