Migrate from Swagger to 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.openapi.swagger.SwaggerToOpenAPI

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

mod config recipes jar install org.openrewrite.recipe:rewrite-openapi:0.33.0

Definition

This recipe runs the following recipes in order.

• Change Gradle or Maven dependencyorg.openrewrite.java.dependencies.ChangeDependency
• Change Gradle or Maven dependencyorg.openrewrite.java.dependencies.ChangeDependency
• Change Gradle or Maven dependencyorg.openrewrite.java.dependencies.ChangeDependency
• Change typeorg.openrewrite.java.ChangeType
• Replace springfox @ApiIgnore on method parameters with @Parameter(hidden = true)org.openrewrite.openapi.swagger.MigrateApiIgnoreParameterToParameterHidden
• Change typeorg.openrewrite.java.ChangeType
• Migrate from @ApiOperation to @Operationorg.openrewrite.openapi.swagger.MigrateApiOperationToOperation
• Migrate from @ApiResponses to @ApiResponsesorg.openrewrite.openapi.swagger.MigrateApiResponsesToApiResponses
• Migrate from @ApiImplicitParams to @Parametersorg.openrewrite.openapi.swagger.MigrateApiImplicitParamsToParameters
• Migrate from @Api to @Tagorg.openrewrite.openapi.swagger.MigrateApiToTag
• Migrate from @ApiParam to @Parameterorg.openrewrite.openapi.swagger.MigrateApiParamToParameter
• Migrate from @ApiModelProperty to @Schemaorg.openrewrite.openapi.swagger.MigrateApiModelPropertyToSchema
• Migrate from @ApiModel to @Schemaorg.openrewrite.openapi.swagger.MigrateApiModelToSchema
• Migrate from @SwaggerDefinition to @OpenAPIDefinitionorg.openrewrite.openapi.swagger.MigrateSwaggerDefinitionToOpenAPIDefinition

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