Skip to content

springdoc openapi 2.x migration guide

bnasslahsen edited this page Jan 26, 2022 · 15 revisions

What's new:

  • Add support for Jakarta EE
  • Add support for Spring-Boot 3
  • Single purpose module: which allows you to cover: spring-boot-starter-actuator, spring-cloud-function-web, therapi-runtime-javadoc, spring-security-web, spring-security-config, jackson-module-kotlin

Requirements

Java 17

Gradle

You need Gradle 7.2 or later to use it with Java 17. If you can't upgrade you can use Gradle Toolchain support to build your project with Java 17.

Main packages changes:

springdoc-openapi-v1 springdoc-openapi-v2
infos General metadata for an OpenAPI definition
infos Info metadata for an OpenAPI definition
infos Properties to describe the contact person for an OpenAPI definition
infos Properties to describe the license for an OpenAPI definition

Known limitations:

spring-native is not yet supported for Java 17,and compatibility with spring-boot 3.0.0-M1

Clone this wiki locally