Upgrade to springdoc-openapi 2

org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2

Migrate applications to the latest spring-doc 2 release. This recipe will modify an application's build files and make changes code changes for removed/updated APIs. See the upgrade guide

Tags

• spring

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-spring

• version: 5.8.0

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-spring:5.8.0 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.8.0")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.12.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-spring:5.8.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>5.8.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe UpgradeSpringDoc_2

Definition

Recipe List

• Remove a Gradle or Maven dependency

  • groupId: org.springdoc

  • artifactId: springdoc-openapi-data-rest

• Remove a Gradle or Maven dependency

  • groupId: org.springdoc

  • artifactId: springdoc-openapi-groovy

• Remove a Gradle or Maven dependency

  • groupId: org.springdoc

  • artifactId: springdoc-openapi-hateoas

• Remove a Gradle or Maven dependency

  • groupId: org.springdoc

  • artifactId: springdoc-openapi-javadoc

• Remove a Gradle or Maven dependency

  • groupId: org.springdoc

  • artifactId: springdoc-openapi-kotlin

• Remove a Gradle or Maven dependency

  • groupId: org.springdoc

  • artifactId: springdoc-openapi-security

• Change Gradle or Maven dependency

  • oldGroupId: org.springdoc

  • oldArtifactId: springdoc-openapi-common

  • newArtifactId: springdoc-openapi-starter-common

  • newVersion: 2.x

• Change Gradle or Maven dependency

  • oldGroupId: org.springdoc

  • oldArtifactId: springdoc-openapi-webmvc-core

  • newArtifactId: springdoc-openapi-starter-webmvc-api

  • newVersion: 2.x

• Change Gradle or Maven dependency

  • oldGroupId: org.springdoc

  • oldArtifactId: springdoc-openapi-webflux-core

  • newArtifactId: springdoc-openapi-starter-webflux-api

  • newVersion: 2.x

• Change Gradle or Maven dependency

  • oldGroupId: org.springdoc

  • oldArtifactId: springdoc-openapi-ui

  • newArtifactId: springdoc-openapi-starter-webmvc-ui

  • newVersion: 2.x

• Change Gradle or Maven dependency

  • oldGroupId: org.springdoc

  • oldArtifactId: springdoc-openapi-webflux-ui

  • newArtifactId: springdoc-openapi-starter-webflux-ui

  • newVersion: 2.x

• Change type

  • oldFullyQualifiedTypeName: org.springdoc.core.SpringDocUtils

  • newFullyQualifiedTypeName: org.springdoc.core.utils.SpringDocUtils

• Change type

  • oldFullyQualifiedTypeName: org.springdoc.api.annotations.ParameterObject

  • newFullyQualifiedTypeName: org.springdoc.core.annotations.ParameterObject

• Change type

  • oldFullyQualifiedTypeName: org.springdoc.core.GroupedOpenApi

  • newFullyQualifiedTypeName: org.springdoc.core.models.GroupedOpenApi

• Change type

  • oldFullyQualifiedTypeName: org.springdoc.core.customizers.OpenApiCustomiser

  • newFullyQualifiedTypeName: org.springdoc.core.customizers.OpenApiCustomizer

• Change type

  • oldFullyQualifiedTypeName: org.springdoc.core.Constants

  • newFullyQualifiedTypeName: org.springdoc.core.utils.Constants

• Change type

  • oldFullyQualifiedTypeName: org.springdoc.core.SwaggerUiConfigParameters

  • newFullyQualifiedTypeName: org.springdoc.core.properties.SwaggerUiConfigParameters

• Change method name

  • methodPattern: org.springdoc.core.models.GroupedOpenApi.Builder addOpenApiCustomiser(..)

  • newMethodName: addOpenApiCustomizer

  • matchOverrides: true

Yaml Recipe List

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2
displayName: Upgrade to springdoc-openapi 2
description: Migrate applications to the latest spring-doc 2 release. This recipe will modify an application's build files and make changes code changes for removed/updated APIs. See the [upgrade guide](https://springdoc.org/#migrating-from-springdoc-v1)

tags:
  - spring
recipeList:
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.springdoc
      artifactId: springdoc-openapi-data-rest
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.springdoc
      artifactId: springdoc-openapi-groovy
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.springdoc
      artifactId: springdoc-openapi-hateoas
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.springdoc
      artifactId: springdoc-openapi-javadoc
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.springdoc
      artifactId: springdoc-openapi-kotlin
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: org.springdoc
      artifactId: springdoc-openapi-security
  - org.openrewrite.java.dependencies.ChangeDependency:
      oldGroupId: org.springdoc
      oldArtifactId: springdoc-openapi-common
      newArtifactId: springdoc-openapi-starter-common
      newVersion: 2.x
  - org.openrewrite.java.dependencies.ChangeDependency:
      oldGroupId: org.springdoc
      oldArtifactId: springdoc-openapi-webmvc-core
      newArtifactId: springdoc-openapi-starter-webmvc-api
      newVersion: 2.x
  - org.openrewrite.java.dependencies.ChangeDependency:
      oldGroupId: org.springdoc
      oldArtifactId: springdoc-openapi-webflux-core
      newArtifactId: springdoc-openapi-starter-webflux-api
      newVersion: 2.x
  - org.openrewrite.java.dependencies.ChangeDependency:
      oldGroupId: org.springdoc
      oldArtifactId: springdoc-openapi-ui
      newArtifactId: springdoc-openapi-starter-webmvc-ui
      newVersion: 2.x
  - org.openrewrite.java.dependencies.ChangeDependency:
      oldGroupId: org.springdoc
      oldArtifactId: springdoc-openapi-webflux-ui
      newArtifactId: springdoc-openapi-starter-webflux-ui
      newVersion: 2.x
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.springdoc.core.SpringDocUtils
      newFullyQualifiedTypeName: org.springdoc.core.utils.SpringDocUtils
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.springdoc.api.annotations.ParameterObject
      newFullyQualifiedTypeName: org.springdoc.core.annotations.ParameterObject
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.springdoc.core.GroupedOpenApi
      newFullyQualifiedTypeName: org.springdoc.core.models.GroupedOpenApi
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.springdoc.core.customizers.OpenApiCustomiser
      newFullyQualifiedTypeName: org.springdoc.core.customizers.OpenApiCustomizer
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.springdoc.core.Constants
      newFullyQualifiedTypeName: org.springdoc.core.utils.Constants
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.springdoc.core.SwaggerUiConfigParameters
      newFullyQualifiedTypeName: org.springdoc.core.properties.SwaggerUiConfigParameters
  - org.openrewrite.java.ChangeMethodName:
      methodPattern: org.springdoc.core.models.GroupedOpenApi.Builder addOpenApiCustomiser(..)
      newMethodName: addOpenApiCustomizer
      matchOverrides: true

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.