OpenAPITools / OpenAPITools/openapi-generator

[BUG JavaSpring] Use useJakartaEe=true and useSpringBoot3=false should generate a library with Spring Boot 2 + JDK17 support + Jakarta proper dependencies

Open
#19,861 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • 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?

Actual: A pom.xml with java.version to 8 and source that it does not compile
Expected: A pom.xml file with java.version to 17 and the jakarta.validation-api and jakarta.annotation dependencies.

Description
openapi-generator version

v7.9.0

OpenAPI declaration file content or url

Anyone, you can find the full example here: https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml

Generation Details

I need to generate a Spring Boot 2 and JDK17 compatible library. For that I use the following command:

java -jar openapi-generator-cli-7.9.0.jar generate -i openapi.yaml -g spring --additional-properties apiPackage=com.example.api.v1,artifactId=api-petstore,groupId=com.example.api,artifactVersion=1.0.0-SNAPSHOT,dateLibrary=java8,library=spring-boot,useJakartaEe=true,useSpringBoot3=false,useSpringController=false,skipDefaultInterface=true,modelPackage=com.example.model.v1,interfaceOnly=true,useSwaggerUI=false,useTags=true -o petstore_interface_only_sb2_jdk17 --global-property models,apis,supportingFiles=pom.xml

And then execute

mvn clean package

We choose useJakartaEe=true and useSpringBoot3=false. The output is a project that it does not compile, due to we are including jakarta packages but spring does not import the proper version of jakarta.validation and jakarta.annotation. Apart of this java.version should be 17.

Compile errors:

[ERROR] /C:/petstore_interface_only_sb2_jdk17/src/main/java/com/example/api/v1/StoreApi.java:[30,1] package jakarta.validation.constraints does not exist
[ERROR] /C:/petstore_interface_only_sb2_jdk17/src/main/java/com/example/model/v1/Customer.java:[13,26] package jakarta.validation does not exist
[ERROR] /C:/petstore_interface_only_sb2_jdk17/src/main/java/com/example/model/v1/Customer.java:[19,26] package jakarta.annotation does not exist

...
[ERROR] /C:/petstore_interface_only_sb2_jdk17/src/main/java/com/example/model/v1/Customer.java:[25,2] cannot find symbol
[ERROR]   symbol: class Generated

...

[ERROR] /C:/petstore_interface_only_sb2_jdk17/src/main/java/com/example/model/v1/Pet.java:[122,4] cannot find symbol
[ERROR]   symbol:   class NotNull
[ERROR]   location: class com.example.model.v1.Pet

...

[ERROR]   location: class com.example.model.v1.Customer
[ERROR] /C:/petstore_interface_only_sb2_jdk17/src/main/java/com/example/model/v1/Customer.java:[92,4] cannot find symbol
[ERROR]   symbol:   class Valid
[ERROR]   location: class com.example.model.v1.Customer
Related issues/PRs

I think these are similar, but only for java libraries:
https://github.com/OpenAPITools/openapi-generator/issues/19398
https://github.com/OpenAPITools/openapi-generator/issues/19437
https://github.com/OpenAPITools/openapi-generator/pull/19171

Suggest a fix

I suppose that I can fix the template including some if/else conditions but I don't know if I have to consider other things.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the reported spring generator command with the linked openapi.yaml, then inspect the generated pom.xml and imports in StoreApi.java and Customer.java. Run mvn clean package; done means the Spring Boot 2 output targets JDK 17, includes the required Jakarta validation and annotation dependencies, and compiles successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring-boot
Domain
api, backend, build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.