Skip to content

Remove springfox from templates#23284

Merged
wing328 merged 6 commits intomasterfrom
springfox-template
Mar 19, 2026
Merged

Remove springfox from templates#23284
wing328 merged 6 commits intomasterfrom
springfox-template

Conversation

@wing328
Copy link
Copy Markdown
Member

@wing328 wing328 commented Mar 19, 2026

a follow up PR to #23283 and #23280

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Remove Springfox from all Java Spring and Kotlin Spring templates. Switch to Springdoc (or source docs), drop /v2/api-docs and @ApiIgnore, remove all springfox conditionals/deps, and stop gating Springdoc config by useSwaggerUI (Boot 2 parent now 2.7.15).

  • Migration
    • Set documentationProvider=springdoc (or source) in your generator config.
    • Update any /v2/api-docs references to /v3/api-docs.
    • Remove io.springfox:springfox-swagger2; use springdoc-openapi deps. Springdoc core is no longer tied to useSwaggerUI.
    • If you used @ApiIgnore, remove it; use @ParameterObject where applicable.

Written for commit d7b3e90. Summary will update on new commits.

@wing328 wing328 added this to the 7.21.0 milestone Mar 19, 2026
@wing328 wing328 marked this pull request as ready for review March 19, 2026 08:07
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 17 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/resources/kotlin-spring/libraries/spring-boot/pom-sb3.mustache">

<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-spring/libraries/spring-boot/pom-sb3.mustache:10">
P2: springdoc-openapi.version is only defined when useSwaggerUI is true, but the springdoc core dependency still uses ${springdoc-openapi.version} when useSwaggerUI is false. Disabling useSwaggerUI will generate a pom.xml with an unresolved property and fail the build.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 3 files (changes from recent commits).

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="samples/server/petstore/kotlin-springboot-additionalproperties/src/main/kotlin/org/openapitools/api/PetApiController.kt">

<violation number="1">
P2: `file` is marked optional (`required = false`) but declared non-null, so requests without that part can fail at runtime instead of being accepted as optional.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@wing328 wing328 merged commit db59785 into master Mar 19, 2026
15 checks passed
@wing328 wing328 deleted the springfox-template branch March 19, 2026 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant