Migrate SpringFox SecurityConfiguration bean to Springdoc properties#1012
Open
steve-aom-elliott wants to merge 1 commit intomainfrom
Open
Migrate SpringFox SecurityConfiguration bean to Springdoc properties#1012steve-aom-elliott wants to merge 1 commit intomainfrom
SecurityConfiguration bean to Springdoc properties#1012steve-aom-elliott wants to merge 1 commit intomainfrom
Conversation
Replace `@Bean` methods returning `springfox.documentation.swagger.web.SecurityConfiguration` with the equivalent `springdoc.swagger-ui.*` configuration properties on the existing `application.properties` or `application.yml` file. Only literal builder arguments are migrated; beans with non-literal arguments or unsupported builder methods (`apiKey`, `apiKeyName`, `apiKeyVehicle`, `additionalQueryStringParams`) are left untouched for manual review. If no Spring application configuration file exists, the bean is left in place to avoid silently dropping configuration. The recipe is wired into the `SpringFoxToSpringDoc` chain after `SecurityContextToSecurityScheme`.
steve-aom-elliott
added
enhancement
Contributor
Author
|
Seems green now following the fix in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new recipe
MigrateSpringFoxSecurityConfigurationthat translates@Beanmethods returningspringfox.documentation.swagger.web.SecurityConfigurationinto the equivalentspringdoc.swagger-ui.*configuration properties on the existingapplication.propertiesorapplication.ymlfile. The bean and its now-unused imports are removed once the properties have been written.The recipe is wired into the
SpringFoxToSpringDocchain afterSecurityContextToSecurityScheme, closing a gap where SpringFox security UI configuration beans were left behind by the migration.Builder method to property mapping
clientIdspringdoc.swagger-ui.oauth.client-idclientSecretspringdoc.swagger-ui.oauth.client-secretrealmspringdoc.swagger-ui.oauth.realmappNamespringdoc.swagger-ui.oauth.app-namescopeSeparatorspringdoc.swagger-ui.oauth.scope-separatoruseBasicAuthenticationWithAccessCodeGrantspringdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grantenableCsrfSupportspringdoc.swagger-ui.csrf.enabledConservative semantics
apiKey,apiKeyName,apiKeyVehicle,additionalQueryStringParams) cause the chain to be skipped — Springdoc has no direct property equivalents.Test plan
MigrateSpringFoxSecurityConfigurationTestcover theenableCsrfSupportliteral case, multiple builder calls, YAML output, and the three opt-out scenarios (non-literal arg, unsupported method, non-@Beanmethod).spring.doc.*andspringdoc.*tests continue to pass.recipes.csvregenerated via./gradlew recipeCsvGenerate.