Fix handling of forwarded headers and servlet context path for swagger ui #60
Conversation
This file contains 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
…r ui In order for the swagger ui to automatically respect the `X-Forwarded-Prefix` header, the config property `server.forward-headers-strategy` must be `framework` when using Tomcat. Additionally, the spring-doc swagger-ui won't respect the servlet context path (i.e. `/acl`) when building URLs and the `X-Forwarded-Prefix` is received (and handled by `org.springframework.web.filter.ForwardedHeaderFilter` as result of `server.forward-headers-strategy=framework`. This patch handles the servlet context suffixing at `SpringDocHomeRedirectController` and `SpringDocAutoConfiguration`.
This was referenced Mar 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In order for the swagger ui to automatically respect the
X-Forwarded-Prefixheader, the config propertyserver.forward-headers-strategymust beframeworkwhen using Tomcat.Additionally, the spring-doc swagger-ui won't respect the servlet context path (i.e.
/acl) when building URLs and theX-Forwarded-Prefixis received (and handled byorg.springframework.web.filter.ForwardedHeaderFilteras result ofserver.forward-headers-strategy=framework.This patch handles the servlet context suffixing at
SpringDocHomeRedirectControllerandSpringDocAutoConfiguration.