Moderne licensed

Migrate from Swagger to SpringDoc and OpenAPI

Recipe IDorg.openrewrite.java.springdoc.SwaggerToSpringDocArtifactorg.openrewrite.recipe:rewrite-spring

Migrate from Swagger to SpringDoc and OpenAPI.

Composite recipespringdocopenapiswaggerMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.java.springdoc.SwaggerToSpringDoc")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

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

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.springdoc.SwaggerToSpringDoc

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:RELEASE

Definition

This recipe runs the following recipes in order.

Migrate from Swagger to OpenAPIorg.openrewrite.openapi.swagger.SwaggerToOpenAPI
Removes @Import(BeanValidatorPluginsConfiguration.class)org.openrewrite.java.spring.doc.RemoveBeanValidatorPluginsConfiguration
Remove annotation @springfox.documentation.swagger2.annotations.EnableSwagger2org.openrewrite.java.RemoveAnnotation
Remove annotation @springfox.documentation.oas.annotations.EnableOpenApiorg.openrewrite.java.RemoveAnnotation
Rewrite safe PathSelectors.regex(...) calls as PathSelectors.ant(...)org.openrewrite.java.spring.doc.NormalizeSpringfoxPathSelectorsRegexToAnt
Migrate Docket to GroupedOpenAPIorg.openrewrite.java.spring.doc.MigrateDocketBeanToGroupedOpenApiBean

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats