Add support for Jakarta EE

[abrudin]

Is your feature request related to a problem? Please describe.
When using springdoc-openapi-ui, one gets a dependency to the old javax-apis through the version of swagger-core that is included (via springdoc-common).

Describe the solution you'd like
It seems swagger has solved this by publishing separate artifacts suffixed with jakarta (See swagger-api/swagger-core#3881). It would be nice if one could do the same with springdoc, or if possible solve it in some other way, so as not have to manually exclude the javax-swagger-versions and include the jakarta-swagger versions a la

implementation(
  'io.swagger.core.v3:swagger-annotations-jakarta:2.1.11',
  'io.swagger.core.v3:swagger-integration-jakarta:2.1.11',
  'io.swagger.core.v3:swagger-models-jakarta:2.1.11'
)

implementation('org.springdoc:springdoc-openapi-ui:1.5.11') {
  exclude(group: 'io.swagger.core.v3', module: 'swagger-annotations')
  exclude(group: 'io.swagger.core.v3', module: 'swagger-integration')
  exclude(group: 'io.swagger.core.v3', module: 'swagger-models')
}

I'm not well enough versed in all the possibilities of configuring dependencies in maven to come up with the best solution to this, but it would be nice if it could be solved somehow, as jakarta.* is where the development will continue.

[bnasslahsen]

@abrudin,

Thank you for your proposal.
What is sure, is that once the support will be fully available in spring 6, the support should also be available in springdoc-openapi.

I think the straightforward solution, is to have separate dependencies: one dedicated for jakarta support and another one for javax.

Don't hesitate to propose a PR, if you have any solutions in mind.

This feature, should anyway be supported and will be added for the next springdoc major release.

[juergenzimmermann]

1st milestone of Spring Boot 3 with support for Jakarta EE 9 is available.

[goafabric]

just found this issue after upgrading to Spring Boot 3.0 M1 ..
OpenAPI crashes by trying to use Reflection for javax Classes (like Servlet) .. which our now gone / replaced by the jakarta ee namespace ..

SpringDoc Version is 1.6.4

at org.springframework.util.ReflectionUtils.getDeclaredMethods(ReflectionUtils.java:461) ~[spring-core-6.0.0-M2.jar:6.0.0-M2]
... 90 common frames omitted

Caused by: java.lang.ClassNotFoundException: javax.servlet.http.HttpServletRequest
at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:641) ~[na:na]
at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:188) ~[na:na]
at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:520) ~[na:na]

[bnasslahsen]

Hi @goafabric,

The support has been added in springdoc-openapi 2 branch.
For now we will Support Jakarta EE 9 and Spring-Boot 3.
springdoc-openapi v2 will require Java 17as a minimum version and Spring Boot 3.x
springdoc-openapi v2 will be released once spring-Boot 3 goes G.A.

This is the link for the demos code:

• https://github.com/springdoc/springdoc-openapi-demos/tree/2.x

If you want to give it a try, this is a first version of the documentation updated here:

• https://springdoc.org/v2/

And this is the migration steps:

• https://github.com/springdoc/springdoc-openapi-demos/wiki/springdoc-openapi-2.x-migration-guide

Note: spring-cloud and spring-native are not yet ready for spring-boot 3 support.

Please feel free to use and test the latest SNAPSHOT: springdoc-openapi v2.0.0-SNAPSHOT.

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.0.0-SNAPSHOT</version>
   </dependency>

Don't hesitate to provide your comments in this ticket.

[juergenzimmermann]

@bnasslahsen Will you release milestones until Spring Boot 3 goes GA or do we have to use snapshots until then?

[bnasslahsen]

@juergenzimmermann,

Ofc we will release milestones until then. We will try to stick to spring-boot ones.
We just need to the SNAPSHOT version enough stable to release it!

Don't hesitate, to give it a try and share your comments.

[juergenzimmermann]

I just upgraded using springdoc-openapi-starter-webflux-ui and it works fine. Thank you for supporting Jakarta EE 9.

[goafabric]

@bnasslahsen
works like a charm .. yeah i know about spring-native .. its not even supported by the spring people
thx for your extraordinary fast support for all things spring

[bnasslahsen]

@juergenzimmermann,

FYI, springdoc-openapi v2.0.0-M1 has been released.