[REQ] Support SpringBoot 3.0 GA for Java-based API code generation #14143

kpupkov-ppa · 2022-11-29T15:58:05Z

Is your feature request related to a problem? Please describe.

We need a new way to generate API with jakarta annotations in code

Describe the solution you'd like

all javax.XXXX is no longer supported and replaced by jakarta

Describe alternatives you've considered

no alternative

Additional context

https://spring.io/blog/2022/11/24/spring-boot-3-0-goes-ga

The text was updated successfully, but these errors were encountered:

maxl2287 · 2022-12-02T08:43:54Z

Same here...
Code-generation is not possible using Spring Boot 3.0.0 with the latest openapi-generator version...

borsch · 2022-12-07T15:04:38Z

@kpupkov-ppa @maxl2287 you can use config property useSpringBoot3 to enable SB3 & Jarakta imports

https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/spring.md

changes are here - https://github.com/OpenAPITools/openapi-generator/pull/12407/files#diff-9de34b4aad5de707e8aa0c031f20a6573f8f50826a437f0652c54b3788b37d41R434

vigourouxc · 2022-12-07T16:09:38Z

The same problem applies to the "java" code generator (client side). We're using java with webclient generator, and the templates use javax.annotation packages that are incompatible with a spring boot 3 application.

pstorch · 2022-12-08T08:09:35Z

@borsch useSpringBoot3 only works for the model classes, but not for the generated restcontroller classes. They are still genereated with javax.annotation.* and javax.validation.* imports.

mlemnian · 2022-12-15T11:45:33Z

@ComputerDaddyGuy mentioned over in the swagger-codegen github repo the following workaround:

Assuming you are generating your objects inside /src/gen/java/your/package, you can add the following plugin to your pom.xml

<plugin>
	<groupId>com.google.code.maven-replacer-plugin</groupId>
	<artifactId>replacer</artifactId>
	<version>1.5.3</version>
	<executions>
		<execution>
			<phase>generate-sources</phase>
			<goals>
				<goal>replace</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<includes>
			<include>${project.basedir}/src/gen/java/**/*.java</include>
		</includes>
		<regex>false</regex>
		<token>javax.annotation</token>
		<value>jakarta.annotation</value>
	</configuration>
</plugin>

You will then see some new logs in your console, after the swagger-codegen-maven-plugin logs:

[INFO] --- replacer:1.5.3:replace (default) @ my-super-api ---
[INFO] Replacement run on 39 files.

source: swagger-api/swagger-codegen#11797 (comment)

The idea is to generate the code as usual but modify it automatically afterward. I'm not a huge fan of this approach but as a workaround, it's "ok".

DennisHartrampf · 2022-12-15T13:13:24Z

We also need Spring Boot 3.0.0 support for Kotlin-Spring. Should this be a separate issue?
Also even useSpringBoot3 (which is not available in Kotlin-Spring) doesn't seem to be the end of the road. It is using Spring Boot 3.0.0-M3 instead of the release version 3.0.0.

DennisHartrampf · 2022-12-15T14:25:29Z

Never mind. There is already an issue for Kotlin-Spring: #13578.

aleksbal · 2022-12-15T19:18:18Z

The solution for this problem would be the use of customised mustache templates in your project. Just copy original templates in a project folder and modify some or all of them by replacing "javax" with "jakarta"...

mlemnian · 2022-12-16T07:31:13Z

@aleksbal IMHO this is not a solution but another workaround.
If there are any changes in the mustache templates in this project, you have to backport the changes into your own project as well.

This whole problem could have been handled years ago (since November 2020 the Jakarta EE 9 spec was released).
Since then openapi-generator but also the swagger-codegen could have implemented a java/jvm wide toggle/flag to use either a jakarta or javax packages.

Why java/jvm wide?
because of

other jvm languages like kotlin and
other APIs like json-b, json-p, jax-rs, bean-validation, ... that also have experienced the package change and
other generators for different frameworks like spring, helidon, camel, jaxrs-*.

E.g. the spring generator has a useSpringBoot3 that doesn't work in some cases.

in helidon-client and helidon-server we have a rootJavaEEPackage and helidonVersion property.
for java clients in general you can set the microprofileRestClientVersion property to 3.0 to implicitly set some root packages to jakarta.

To be honest, this is not a great experience.

aleksbal · 2022-12-16T10:24:16Z

@mlemnian

Well, I think it is legit to use customised mustache templates for code generation in order to solve some specific project needs. However I agree that javax/jakarta problem is not really "the specific one" but rather the one which affects the whole ecosystem.

Since then openapi-generator but also the swagger-codegen could have implemented a java/jvm wide toggle/flag to use either a jakarta or javax packages.

Actually they've bee trying, for example, if you have a look in the templates from OpenAPI generator's Java Spring module (v6.2.1) you will find a flag called "useJakartaEe", which determines whether to generate the Java classes using "javax." or "jakarta."...

borsch · 2022-12-16T15:57:10Z

@borsch useSpringBoot3 only works for the model classes, but not for the generated restcontroller classes. They are still genereated with javax.annotation.* and javax.validation.* imports.

@pstorch could you please provide a sample for this? I don't see any javax imports in SB3 generated project

aleksbal · 2022-12-16T22:49:25Z

I however was not able to utilise the "useJakartaEe", just have seen it in the templates but to set the flag to true or false didn't work for me, so I adjusted the original templates to fit our needs. I would appreciate any example which demonstrates the usability. Thx.

pstorch · 2022-12-17T11:10:24Z

@borsch mea culpa. I verified it again and the one project which had this issue is using custom templates, which use the javax namespace. 🤦 Sorry, I didn't see that.

borsch · 2022-12-21T11:28:03Z

Recently these two MRs were merged with upgrades on SP3 to 3.0.0 & update for SB 2.7.x.
jakarta as for now is available only with SP3 which can be enabled with useSpringBoot3=true option

Any other issues to be covered here? Otherwise make sense to close this one

#14283
#14285

alwibrm · 2022-12-27T14:06:59Z

Hi @borsch, when using generator java with library webclient the generated code still contains javax.* instead of jakarta.*, even with the config option <useSpringBoot3>true</useSpringBoot3>. This is a blocker for us to upgrade on Spring Boot 3.

borsch · 2022-12-27T14:34:11Z

@alwibrm webclient doesn't yet support neither SB3 nor jakarta. This change is in progress

alwibrm · 2022-12-27T15:23:19Z

@borsch Thanks for the quick reply. Is there an open issue for that or a planned release version/date?

borsch · 2022-12-27T19:21:38Z

@alwibrm I'm aware only about rest-template update to spring 6 #14276

alwibrm · 2022-12-29T12:24:11Z

@borsch You mentioned the change for webclient was in progress. Is there any issue or merge request for this? Otherwise I would consider contributing a merge request.

parenko · 2023-01-02T09:21:54Z

FYI: with #14343 it is now possible to enable jakarta namespace for non SB3 Java templates by using useJakartaEe=true.

LSzelecsenyi · 2023-01-19T12:31:22Z

Hi. I am trying to upgrade our project to spring-boot 3. During this I encountered the javax/jakarta issue. Upgraded the openapi-generator to 6.2.0 and made the setting <useSpringBoot3>true</useSpringBoot3> in the pom.xml but still having problem with javax.ws.rs.core. I am having error "package javax.ws.rs.core does not exist". Any idea how to fix it? Thanks in advance!

mlemnian · 2023-02-03T12:45:41Z

Hi. I am trying to upgrade our project to spring-boot 3. During this I encountered the javax/jakarta issue. Upgraded the openapi-generator to 6.2.0 and made the setting <useSpringBoot3>true</useSpringBoot3> in the pom.xml but still having problem with javax.ws.rs.core. I am having error "package javax.ws.rs.core does not exist". Any idea how to fix it? Thanks in advance!

@LSzelecsenyi
Suppose your application code references the old javax.* classes, you have to rename every occurrence of the name javax to jakarta inside of your code. (and update your maven/gradle dependencies)

If this reference is inside the generated code, this is odd.
Spring usually doesn't use a lot of JavaEE/JakartaEE classes/APIs, maybe you don't use the spring (<generatorName>spring</generatorName>) generator at all?

parenko · 2023-02-04T09:33:19Z

@kpupkov-ppa , could you please try the latest 6.3.0 release if your requiment is met?

LSzelecsenyi · 2023-02-04T12:00:56Z

@LSzelecsenyi Suppose your application code references the old javax.* classes, you have to rename every occurrence of the name javax to jakarta inside of your code. (and update your maven/gradle dependencies)

If this reference is inside the generated code, this is odd. Spring usually doesn't use a lot of JavaEE/JakartaEE classes/APIs, maybe you don't use the spring (<generatorName>spring</generatorName>) generator at all?

@mlemnian Thanks for the reply.
In my code I changed every import to jakarta, the problem is with the generated stuff only.
I am using spring in the generator's config.
For a temporary fix I am using maven-replacer-plugin to change javax from the generated code

parenko · 2023-02-04T21:04:42Z

@LSzelecsenyi Suppose your application code references the old javax.* classes, you have to rename every occurrence of the name javax to jakarta inside of your code. (and update your maven/gradle dependencies)
If this reference is inside the generated code, this is odd. Spring usually doesn't use a lot of JavaEE/JakartaEE classes/APIs, maybe you don't use the spring (<generatorName>spring</generatorName>) generator at all?

@mlemnian Thanks for the reply. In my code I changed every import to jakarta, the problem is with the generated stuff only. I am using spring in the generator's config. For a temporary fix I am using maven-replacer-plugin to change javax from the generated code

@LSzelecsenyi please try 6.3.0 with configOption <useJakartaEe>true</useJakartaEe>.

LSzelecsenyi · 2023-02-07T10:53:31Z

@LSzelecsenyi please try 6.3.0 with configOption <useJakartaEe>true</useJakartaEe>.

@parenko
I am trying with <useSpringBoot3>true</useSpringBoot3> doc says:

useSpringBoot3: Generate code and provide dependencies for use with Spring Boot 3.x. (Use jakarta instead of javax in imports). Enabling this option will also enable useJakartaEe.

Tried with 6.3.0 but without the replacer I am getting the same error: package javax.ws.rs.core does not exist

pstorch · 2023-02-07T11:18:24Z

For me it worked with 6.2.1 and 6.3.0 with configOption <useSpringBoot3>true</useSpringBoot3>
@LSzelecsenyi can you show your maven/gradle section? Do you use custom templates?

LSzelecsenyi · 2023-02-07T11:43:55Z

@pstorch

<plugin>
	<groupId>org.openapitools</groupId>
	<artifactId>openapi-generator-maven-plugin</artifactId>
	<version>6.3.0</version>
	<executions>
		<execution>
			<goals>
				<goal>generate</goal>
			</goals>
			<configuration>
				<inputSpec>
					${basedir}/src/main/resources/openapi/api.yaml
				</inputSpec>
				<generatorName>spring</generatorName>
				<apiPackage>${project.groupId}.foo.client</apiPackage>
				<modelPackage>${project.groupId}.foo.model</modelPackage>
				<supportingFilesToGenerate>ApiUtil.java</supportingFilesToGenerate>
				<configOptions>
					<openApiNullable>false</openApiNullable>
					<useTags>true</useTags>
					<useSpringBoot3>true</useSpringBoot3>
					<sourceFolder>src/main/java/</sourceFolder>
					<delegatePattern>true</delegatePattern>
					<interfaceOnly>true</interfaceOnly>
				</configOptions>
			</configuration>
		</execution>
	</executions>
</plugin>

alwibrm · 2023-02-07T14:40:10Z

The config option <useJakartaEe>true</useJakartaEe> in version 6.3.0 for generator java and library webclient now leads to the correct jakarta.* namespaces.

Unfortunately the build is still broken because of a cannot find symbol exception in Schema.RequiredMode.

This is because there are two different versions of swagger-annotations on the classpath, 1.6.8 and 2.2.4:

[INFO] +- org.openapitools:openapi-generator:jar:6.3.0:compile
[INFO] |  +- io.swagger.parser.v3:swagger-parser:jar:2.1.6:compile
[INFO] |  |  +- io.swagger.parser.v3:swagger-parser-v2-converter:jar:2.1.6:compile
[INFO] |  |  |  +- io.swagger:swagger-core:jar:1.6.8:compile
[INFO] |  |  |  |  +- io.swagger:swagger-models:jar:1.6.8:compile
[INFO] |  |  |  |  |  \- io.swagger:swagger-annotations:jar:1.6.8:compile
[INFO] |  |  \- io.swagger.parser.v3:swagger-parser-v3:jar:2.1.6:compile
[INFO] |  |     +- io.swagger.core.v3:swagger-core:jar:2.2.4:compile
[INFO] |  |     |  +- io.swagger.core.v3:swagger-annotations:jar:2.2.4:compile

pstorch · 2023-02-07T18:17:03Z

@LSzelecsenyi ok, I don't see any obvious mistakes.

parenko · 2023-02-13T23:53:50Z

@LSzelecsenyi could you also share your api.yaml which causes "package javax.ws.rs.core does not exist"?
Currently I cant reproduce the error only with provided plugin configuration.

laidani · 2023-03-18T21:12:12Z

For feature readers, I solved the issue by adding these dependencies to my project plus <useSpringBoot3>true</useSpringBoot3>:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>jackson-databind-nullable</artifactId>
    <version>0.2.6</version>
</dependency>
<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>3.0.2</version>
</dependency>
<dependency>
    <groupId>io.swagger.core.v3</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>2.2.8</version>
</dependency>

aquacode · 2023-05-15T19:00:24Z

I'm using the https://github.com/int128/gradle-swagger-generator-plugin plugin along with openapi-generator-cli version 6.6.0 and I am also noticing this for:
generator: spring
library: spring-boot

How are people working around this issue? I seem to have the correct annotations bytecode since my version of Schema on classpath doesn't have the requiredCode property or RequiredMode.

It seems to be a problem with the model code generation using the outdated requiredMode property. Is that a problem in the mustache template? Is there any workaround?

max-kry · 2023-05-24T06:57:11Z

The workaround ended up being:

check out openapi-generator
copy gradle.build.mustache of your choice (for example from openapi-generator/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/) into a folder, say templates
in the template replace
- jakarta_annotation_version = "1.3.5"
  with
  jakarta_annotation_version = "2.1.1"
- implementation 'javax.ws.rs:javax.ws.rs-api:2.1.1'
  with
  implementation 'jakarta.ws.rs:jakarta.ws.rs-api:3.1.0'
point the generator at the patched template using templateDir property

task generate(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask) {
    generatorName = "java"
    ..
    templateDir = "$projectDir/templates".toString()
    ..
    configOptions = [
            ..
            useJakartaEe            : "true",
            ..

ario-afrashteh · 2023-06-19T08:43:09Z

Any update guys?

frankjkelly · 2023-06-22T20:12:19Z

Thanks to @laidani I was able to get passed the
cannot find symbol
on requiredMode = Schema.RequiredMode.REQUIRED by forcibly updating the following

  implementation('io.swagger.core.v3:swagger-annotations:+') {
    because("we get error that we cannot find a symobl on Schema.RequiredMode. See https://github.com/OpenAPITools/openapi-generator/issues/14143 ")
  }

Philzen · 2024-06-02T03:42:47Z

@kpupkov-ppa correct me if i'm wrong, but as far as i understand code generation for java with spring boot 3 is working fine nowadays … if you agree, kindly close this issue.

tukez · 2024-07-17T04:55:21Z

There is still problem with the generated controllers which use javax annotation imports.

pstorch · 2024-07-17T05:14:12Z

@tukez as far es I can see the imports are all fine if you use the useSpringBoot3 option.

tukez · 2024-07-17T06:22:55Z

@pstorch Thank you, that is correct. It was some Eclipse problem which was corrected once I manually deleted the old generated file (Eclipse clean was not enough for some reason).

Philzen · 2024-07-17T20:52:53Z

@tukez @kpupkov-ppa as confirmed now, useSpringBoot3 (or only useJakartaEe for that matter) flags do the job.

Closing this issue for now. Should anyone come across a specific java generator that doesn't respect these flags correctly, kindly open a new issue so they can be targeted and fixed in more atomic PRs.

kpupkov-ppa added the Enhancement: Feature label Nov 29, 2022

borsch mentioned this issue Dec 16, 2022

[Java][Spring] config option to use Jakarta EE package #14272

Closed

5 tasks

adang-teamim mentioned this issue Mar 30, 2023

Java SDK (v1.1.1) - java.lang.NoClassDefFoundError: javax/ws/rs/core/Configuration hellosign/hellosign-openapi#285

Closed

Philzen mentioned this issue Oct 3, 2023

[REQ] RestTemplate support for Spring boot 3 #14696

Open

Philzen closed this as completed Jul 17, 2024

[REQ] Support SpringBoot 3.0 GA for Java-based API code generation #14143

[REQ] Support SpringBoot 3.0 GA for Java-based API code generation #14143

Comments

kpupkov-ppa commented Nov 29, 2022

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

maxl2287 commented Dec 2, 2022

borsch commented Dec 7, 2022

vigourouxc commented Dec 7, 2022

pstorch commented Dec 8, 2022 • edited Loading

mlemnian commented Dec 15, 2022

DennisHartrampf commented Dec 15, 2022

DennisHartrampf commented Dec 15, 2022

aleksbal commented Dec 15, 2022

mlemnian commented Dec 16, 2022 • edited Loading

aleksbal commented Dec 16, 2022

borsch commented Dec 16, 2022 • edited Loading

aleksbal commented Dec 16, 2022

pstorch commented Dec 17, 2022

borsch commented Dec 21, 2022

alwibrm commented Dec 27, 2022

borsch commented Dec 27, 2022

alwibrm commented Dec 27, 2022

borsch commented Dec 27, 2022

alwibrm commented Dec 29, 2022

parenko commented Jan 2, 2023

LSzelecsenyi commented Jan 19, 2023

mlemnian commented Feb 3, 2023 • edited Loading

parenko commented Feb 4, 2023

LSzelecsenyi commented Feb 4, 2023 • edited Loading

parenko commented Feb 4, 2023 • edited Loading

LSzelecsenyi commented Feb 7, 2023 • edited Loading

pstorch commented Feb 7, 2023

LSzelecsenyi commented Feb 7, 2023 • edited Loading

alwibrm commented Feb 7, 2023

pstorch commented Feb 7, 2023

parenko commented Feb 13, 2023

laidani commented Mar 18, 2023

aquacode commented May 15, 2023

max-kry commented May 24, 2023 • edited Loading

ario-afrashteh commented Jun 19, 2023

frankjkelly commented Jun 22, 2023

Philzen commented Jun 2, 2024

tukez commented Jul 17, 2024

pstorch commented Jul 17, 2024

tukez commented Jul 17, 2024

Philzen commented Jul 17, 2024

pstorch commented Dec 8, 2022 •

edited

Loading

mlemnian commented Dec 16, 2022 •

edited

Loading

borsch commented Dec 16, 2022 •

edited

Loading

mlemnian commented Feb 3, 2023 •

edited

Loading

LSzelecsenyi commented Feb 4, 2023 •

edited

Loading

parenko commented Feb 4, 2023 •

edited

Loading

LSzelecsenyi commented Feb 7, 2023 •

edited

Loading

LSzelecsenyi commented Feb 7, 2023 •

edited

Loading

max-kry commented May 24, 2023 •

edited

Loading