Migrate from Swagger to SpringDoc and OpenAPI org.openrewrite.java.springdoc.SwaggerToSpringDoc
Migrate from Swagger to SpringDoc and OpenAPI.
Tags
Recipe source
GitHub , Issue Tracker , Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-spring
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 Gradle init script Maven POM Maven Command Line Moderne CLI
Add the following to your build.gradle
file:
Copy plugins {
id( "org.openrewrite.rewrite" ) version( "6.12.0" )
}
rewrite {
activeRecipe( "org.openrewrite.java.springdoc.SwaggerToSpringDoc" )
}
repositories {
mavenCentral()
}
dependencies {
rewrite( "org.openrewrite.recipe:rewrite-spring:5.8.0" )
}
Run gradle rewriteRun
to run the recipe.
Create a file named init.gradle
in the root of your project.
Copy 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.springdoc.SwaggerToSpringDoc" )
}
afterEvaluate {
if (repositories . isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
Run gradle --init-script init.gradle rewriteRun
to run the recipe.
Add the following to your pom.xml
file:
Copy < 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.springdoc.SwaggerToSpringDoc</ 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 >
Run mvn rewrite:run
to run the recipe.
Copy mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.springdoc.SwaggerToSpringDoc
You will need to have configured the Moderne CLI on your machine before you can run the following command.
Copy mod run . --recipe SwaggerToSpringDoc
Definition
Recipe List Yaml Recipe List
Copy ---
type : specs.openrewrite.org/v1beta/recipe
name : org.openrewrite.java.springdoc.SwaggerToSpringDoc
displayName : Migrate from Swagger to SpringDoc and OpenAPI
description : Migrate from Swagger to SpringDoc and OpenAPI.
tags :
- openapi
- springdoc
- swagger
recipeList :
- org.openrewrite.openapi.swagger.SwaggerToOpenAPI
- org.openrewrite.java.springdoc.UpgradeSpringDoc_2
- org.openrewrite.java.spring.DeleteSpringProperty :
propertyKey : swagger.title
- org.openrewrite.java.spring.DeleteSpringProperty :
propertyKey : swagger.description
- org.openrewrite.java.spring.DeleteSpringProperty :
propertyKey : swagger.contact
- org.openrewrite.maven.RemoveDependency :
groupId : io.swagger.core.v3
artifactId : swagger-annotations
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.
Contributors
Tyler Van Gorder, Tim te Beek , Knut Wannheden , Patrick , Kun Li, Jonathan Schnéider