OpenAPITools / openapi-generator

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
https://openapi-generator.tech
Apache License 2.0
21.88k stars 6.59k forks source link

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

Open mgvinuesa opened 1 month ago

mgvinuesa commented 1 month ago

Bug Report Checklist

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.

wing328 commented 1 day ago

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.

I wonder if you can file a PR to start with and we will review accordingly.