← All recipes
Open source

Replace springfox @ApiIgnore on method parameters with @Parameter(hidden = true)

Recipe IDorg.openrewrite.openapi.swagger.MigrateApiIgnoreParameterToParameterHidden
Artifactorg.openrewrite.recipe:rewrite-openapi

Springfox's @ApiIgnore is commonly placed on framework-injected controller parameters (Principal, HttpServletRequest, Pageable, ...). A flat ChangeType to io.swagger.v3.oas.annotations.Hidden produces code that does not compile, because @Hidden cannot target parameters. Convert parameter usages directly to @io.swagger.v3.oas.annotations.Parameter(hidden = true) and leave method/class-level @ApiIgnore for the subsequent ChangeType step.

Single recipeApache 2.0

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.MigrateApiIgnoreParameterToParameterHidden

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

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

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