chore(backend): Explicitly enable SpringDoc API docs and Swagger UI to avoid warnings#5420
Merged
corneliusroemer merged 1 commit intomainfrom Nov 13, 2025
Merged
Conversation
corneliusroemer
changed the title
corneliusroemer
requested review from
anna-parker,
fengelniederhammer and
theosanderson
corneliusroemer
added
preview
…avoid warnings This commit explicitly enables the SpringDoc API documentation and Swagger UI endpoints in . This change addresses warnings introduced in springdoc-openapi-starter-webmvc-ui version 2.8.14 (and potentially earlier versions) which appear when these endpoints are enabled by default. The warnings prompt developers to explicitly set and in production to prevent accidental exposure. The specific warnings are: - 2025-11-12 13:54:38,267 WARN [main] [] [] - org.springdoc.core.events.SpringDocAppInitializer: SpringDoc /api-docs endpoint is enabled by default. To disable it in production, set the property 'springdoc.api-docs.enabled=false' - 2025-11-12 13:54:38,267 WARN [main] [] [] - org.springdoc.core.events.SpringDocAppInitializer: SpringDoc /swagger-ui.html endpoint is enabled by default. To disable it in production, set the property 'springdoc.swagger-ui.enabled=false' This change aligns with the recommendations from the springdoc-openapi project, as discussed in PR springdoc/springdoc-openapi#3090. The dependency version bump is being handled in #5410.
corneliusroemer
force-pushed
the
fix-warning-springdoc
branch
from
4b268fb to
5b433fc
Compare
fengelniederhammer
approved these changes
Nov 12, 2025
This was referenced Nov 14, 2025
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
2 participants
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.
This commit explicitly enables the SpringDoc API documentation and Swagger UI
endpoints - rather than using implicit defaults.
This change addresses warnings introduced in springdoc-openapi-starter-webmvc-ui
version 2.8.14 (and potentially earlier versions) which appear when these
endpoints are enabled implicitly by default.
The specific warnings are:
This change aligns with the recommendations from the springdoc-openapi project,
as discussed in PR springdoc/springdoc-openapi#3090.
The dependency version bump is being handled in #5410.
Screenshot
PR Checklist
🚀 Preview: https://fix-warning-springdoc.loculus.org