Migrate from SpringFox Swagger to SpringDoc and OpenAPI
Recipe ID
org.openrewrite.java.springdoc.SpringFoxToSpringDocArtifact
org.openrewrite.recipe:rewrite-springMigrate from SpringFox Swagger to SpringDoc and OpenAPI.
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.SpringFoxToSpringDocIf the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.36.0Definition
This recipe runs the following recipes in order.
- Add comment to method invocations
org.openrewrite.java.AddCommentToMethodInvocations - Add comment to method invocations
org.openrewrite.java.AddCommentToMethodInvocations - Migrate from Swagger to SpringDoc and OpenAPI
org.openrewrite.java.springdoc.SwaggerToSpringDoc - Replace SpringFox Dependencies
org.openrewrite.java.springdoc.ReplaceSpringFoxDependencies - Migrate
ApiInfoBuildertoInfoorg.openrewrite.java.spring.doc.ApiInfoBuilderToInfo - Replace elements of SpringFox's security with Swagger's security models
org.openrewrite.java.spring.doc.SecurityContextToSecurityScheme - Migrate SpringFox
SecurityConfigurationbean to Springdoc Swagger UI propertiesorg.openrewrite.java.spring.doc.MigrateSpringFoxSecurityConfiguration - Migrate from springdoc-openapi-common to springdoc-openapi-starter-common
org.openrewrite.java.springdoc.MigrateSpringdocCommon - Remove remaining Springfox dead code
org.openrewrite.java.springdoc.CleanupRemainingSpringfox
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