Calling Swagger UI via different context paths fails. Fixes #2642

Author: bnasslahsen

Diff for: springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/AbstractSwaggerUiConfigProperties.java

@@ -31,8 +31,10 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import org.apache.commons.lang3.StringUtils;
+import org.springdoc.core.utils.Constants;
 
 import static org.springdoc.core.utils.Constants.GROUP_NAME_NOT_NULL_OR_EMPTY;
+import static org.springdoc.core.utils.Constants.SWAGGER_UI_OAUTH_REDIRECT_URL;
 
 /**
  * Please refer to the swagger
@@ -45,7 +47,7 @@ public abstract class AbstractSwaggerUiConfigProperties {
 	/**
 	 * The path for the Swagger UI pages to load. Will redirect to the springdoc.webjars.prefix property.
 	 */
-	protected String path;
+	protected String path = Constants.DEFAULT_SWAGGER_UI_PATH;
 
 	/**
 	 * The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
@@ -138,7 +140,7 @@ public abstract class AbstractSwaggerUiConfigProperties {
 	/**
 	 * OAuth redirect URL.
 	 */
-	protected String oauth2RedirectUrl;
+	protected String oauth2RedirectUrl = SWAGGER_UI_OAUTH_REDIRECT_URL;
 
 	/**
 	 * The Url.

Diff for: springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SwaggerUiConfigParameters.java

@@ -53,10 +53,6 @@
  * The type Swagger ui config parameters.
  * @author bnasslahsen
  */
-@Lazy(false)
-@Configuration(proxyBeanMethods = false)
-@ConditionalOnProperty(name = SPRINGDOC_SWAGGER_UI_ENABLED, matchIfMissing = true)
-@ConditionalOnBean(SpringDocConfiguration.class)
 public class SwaggerUiConfigParameters extends AbstractSwaggerUiConfigProperties {
 
 	/**
@@ -149,6 +145,20 @@ public class SwaggerUiConfigParameters extends AbstractSwaggerUiConfigProperties
 	 */
 	private String uiRootPath;
 
+	/**
+	 * The Context path.
+	 */
+	private String contextPath;
+
+	/**
+	 * The Context path.
+	 */
+	private String apiDocsUrl;
+
+	/**
+	 * The Path prefix.
+	 */
+	private String pathPrefix;
 
 	/**
 	 * Instantiates a new Swagger ui config parameters.
@@ -157,8 +167,8 @@ public class SwaggerUiConfigParameters extends AbstractSwaggerUiConfigProperties
 	 */
 	public SwaggerUiConfigParameters(SwaggerUiConfigProperties swaggerUiConfig) {
 		this.swaggerUiConfig = swaggerUiConfig;
-		this.path = StringUtils.defaultIfBlank(swaggerUiConfig.getPath(), Constants.DEFAULT_SWAGGER_UI_PATH);
-		this.oauth2RedirectUrl = StringUtils.defaultIfBlank(swaggerUiConfig.getOauth2RedirectUrl(), SWAGGER_UI_OAUTH_REDIRECT_URL);
+		this.path = swaggerUiConfig.getPath();
+		this.oauth2RedirectUrl = swaggerUiConfig.getOauth2RedirectUrl();
 		this.layout = swaggerUiConfig.getLayout();
 		this.configUrl = swaggerUiConfig.getConfigUrl();
 		this.validatorUrl = swaggerUiConfig.getValidatorUrl();
@@ -325,4 +335,58 @@ private boolean isSwaggerUrlDefined(String name) {
 			return swaggerUiConfig.getUrls().stream().anyMatch(swaggerUrl -> name.equals(swaggerUrl.getName()) && StringUtils.isNotBlank(swaggerUrl.getUrl()));
 		return false;
 	}
+
+	/**
+	 * Gets context path.
+	 *
+	 * @return the context path
+	 */
+	public String getContextPath() {
+		return contextPath;
+	}
+
+	/**
+	 * Sets context path.
+	 *
+	 * @param contextPath the context path
+	 */
+	public void setContextPath(String contextPath) {
+		this.contextPath = contextPath;
+	}
+
+	/**
+	 * Gets api docs url.
+	 *
+	 * @return the api docs url
+	 */
+	public String getApiDocsUrl() {
+		return apiDocsUrl;
+	}
+
+	/**
+	 * Sets api docs url.
+	 *
+	 * @param apiDocsUrl the api docs url
+	 */
+	public void setApiDocsUrl(String apiDocsUrl) {
+		this.apiDocsUrl = apiDocsUrl;
+	}
+
+	/**
+	 * Gets path prefix.
+	 *
+	 * @return the path prefix
+	 */
+	public String getPathPrefix() {
+		return pathPrefix;
+	}
+
+	/**
+	 * Sets path prefix.
+	 *
+	 * @param pathPrefix the path prefix
+	 */
+	public void setPathPrefix(String pathPrefix) {
+		this.pathPrefix = pathPrefix;
+	}
 }

Diff for: springdoc-openapi-starter-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java

@@ -61,11 +61,6 @@ public class AbstractSwaggerIndexTransformer {
 	 */
 	protected SwaggerUiOAuthProperties swaggerUiOAuthProperties;
 
-	/**
-	 * The Swagger ui config parameters.
-	 */
-	protected SwaggerUiConfigParameters swaggerUiConfigParameters;
-
 	/**
 	 * The Object mapper.
 	 */
@@ -81,13 +76,11 @@ public class AbstractSwaggerIndexTransformer {
 	 *
 	 * @param swaggerUiConfig the swagger ui config
 	 * @param swaggerUiOAuthProperties the swagger ui o auth properties
-	 * @param swaggerUiConfigParameters the swagger ui config parameters
 	 * @param objectMapperProvider the object mapper provider
 	 */
-	public AbstractSwaggerIndexTransformer(SwaggerUiConfigProperties swaggerUiConfig, SwaggerUiOAuthProperties swaggerUiOAuthProperties, SwaggerUiConfigParameters swaggerUiConfigParameters, ObjectMapperProvider objectMapperProvider) {
+	public AbstractSwaggerIndexTransformer(SwaggerUiConfigProperties swaggerUiConfig, SwaggerUiOAuthProperties swaggerUiOAuthProperties, ObjectMapperProvider objectMapperProvider) {
 		this.swaggerUiConfig = swaggerUiConfig;
 		this.swaggerUiOAuthProperties = swaggerUiOAuthProperties;
-		this.swaggerUiConfigParameters = swaggerUiConfigParameters;
 		this.objectMapper = objectMapperProvider.jsonMapper();
 	}
 
@@ -148,11 +141,12 @@ protected String setConfiguredApiDocsUrl(String html){
 	/**
 	 * Default transformations string.
 	 *
-	 * @param inputStream the input stream
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param inputStream               the input stream
 	 * @return the string
 	 * @throws IOException the io exception
 	 */
-	protected String defaultTransformations(InputStream inputStream) throws IOException {
+	protected String defaultTransformations(SwaggerUiConfigParameters swaggerUiConfigParameters, InputStream inputStream) throws IOException {
 		String html = readFullyAsString(inputStream);
 		if (!CollectionUtils.isEmpty(swaggerUiOAuthProperties.getConfigParameters()))
 			html = addInitOauth(html);
@@ -170,7 +164,7 @@ else if (swaggerUiConfig.getCsrf().isUseSessionStorage())
 			html = addSyntaxHighlight(html);
 
 		if (swaggerUiConfig.getQueryConfigEnabled() == null || !swaggerUiConfig.getQueryConfigEnabled())
-			html = addParameters(html);
+			html = addParameters(html, swaggerUiConfigParameters);
 		else
 			html = addParameter(html, QUERY_CONFIG_ENABLED_PROPERTY, swaggerUiConfig.getQueryConfigEnabled().toString());
 
@@ -191,7 +185,7 @@ else if (swaggerUiConfig.getCsrf().isUseSessionStorage())
 	 * @return the string
 	 * @throws JsonProcessingException the json processing exception
 	 */
-	protected String addParameters(String html) throws JsonProcessingException {
+	protected String addParameters(String html, SwaggerUiConfigParameters swaggerUiConfigParameters) throws JsonProcessingException {
 		String layout = swaggerUiConfigParameters.getLayout() != null ? swaggerUiConfigParameters.getLayout() : "StandaloneLayout";
 		StringBuilder stringBuilder = new StringBuilder("layout: \"" + layout + "\" ,\n");
 

Diff for: springdoc-openapi-starter-common/src/main/java/org/springdoc/ui/AbstractSwaggerWelcome.java

@@ -57,45 +57,23 @@ public abstract class AbstractSwaggerWelcome {
 	 */
 	protected final SpringDocConfigProperties springDocConfigProperties;
 
-	/**
-	 * The Swagger ui calculated config.
-	 */
-	protected final SwaggerUiConfigParameters swaggerUiConfigParameters;
-
-	/**
-	 * The Swagger config url.
-	 */
-	protected String swaggerConfigUrl;
-
-	/**
-	 * The Api docs url.
-	 */
-	protected String apiDocsUrl;
-
-	/**
-	 * The Context path.
-	 */
-	protected String contextPath;
-
 	/**
 	 * Instantiates a new Abstract swagger welcome.
 	 *
 	 * @param swaggerUiConfig the swagger ui config
 	 * @param springDocConfigProperties the spring doc config properties
-	 * @param swaggerUiConfigParameters the swagger ui config parameters
 	 */
-	public AbstractSwaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties, SwaggerUiConfigParameters swaggerUiConfigParameters) {
+	public AbstractSwaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties) {
 		this.swaggerUiConfig = swaggerUiConfig;
 		this.springDocConfigProperties = springDocConfigProperties;
-		this.swaggerUiConfigParameters = swaggerUiConfigParameters;
 	}
 
 	/**
 	 * Init.
 	 */
-	protected void init() {
+	protected void init(SwaggerUiConfigParameters swaggerUiConfigParameters) {
 		springDocConfigProperties.getGroupConfigs().forEach(groupConfig -> swaggerUiConfigParameters.addGroup(groupConfig.getGroup(), groupConfig.getDisplayName()));
-		calculateUiRootPath();
+		calculateUiRootPath(swaggerUiConfigParameters);
 	}
 
 	/**
@@ -117,30 +95,30 @@ protected String buildUrl(String contextPath, String docsUrl) {
 	/**
 	 * Build config url.
 	 *
-	 * @param uriComponentsBuilder the uri components builder
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param uriComponentsBuilder      the uri components builder
 	 */
-	protected void buildConfigUrl(UriComponentsBuilder uriComponentsBuilder) {
+	protected void buildConfigUrl(SwaggerUiConfigParameters swaggerUiConfigParameters, UriComponentsBuilder uriComponentsBuilder) {
 		if (StringUtils.isEmpty(swaggerUiConfig.getConfigUrl())) {
-			apiDocsUrl = buildApiDocUrl();
-			swaggerConfigUrl = buildSwaggerConfigUrl();
-			swaggerUiConfigParameters.setConfigUrl(swaggerConfigUrl);
+			buildApiDocUrl(swaggerUiConfigParameters);
+			buildSwaggerConfigUrl(swaggerUiConfigParameters);
 			if (CollectionUtils.isEmpty(swaggerUiConfigParameters.getUrls())) {
 				String swaggerUiUrl = swaggerUiConfig.getUrl();
 				if (StringUtils.isEmpty(swaggerUiUrl))
-					swaggerUiConfigParameters.setUrl(apiDocsUrl);
+					swaggerUiConfigParameters.setUrl(swaggerUiConfigParameters.getApiDocsUrl());
 				else if (swaggerUiConfigParameters.isValidUrl(swaggerUiUrl))
 					swaggerUiConfigParameters.setUrl(swaggerUiUrl);
 				else
-					swaggerUiConfigParameters.setUrl(buildUrlWithContextPath(swaggerUiUrl));
+					swaggerUiConfigParameters.setUrl(buildUrlWithContextPath(swaggerUiConfigParameters, swaggerUiUrl));
 			}
 			else
-				swaggerUiConfigParameters.addUrl(apiDocsUrl);
+				swaggerUiConfigParameters.addUrl(swaggerUiConfigParameters.getApiDocsUrl());
 			if (!CollectionUtils.isEmpty(swaggerUiConfig.getUrls())) {
 				swaggerUiConfig.cloneUrls()
 						.stream()
 						.filter(swaggerUrl -> !swaggerUiConfigParameters.isValidUrl(swaggerUrl.getUrl()))
 						.forEach(swaggerUrl -> {
-							final var url = buildUrlWithContextPath(swaggerUrl.getUrl());
+							final var url = buildUrlWithContextPath(swaggerUiConfigParameters, swaggerUrl.getUrl());
 							if (!Objects.equals(url, swaggerUrl.getUrl())) {
 								swaggerUiConfigParameters.getUrls()
 										.stream()
@@ -150,24 +128,26 @@ else if (swaggerUiConfigParameters.isValidUrl(swaggerUiUrl))
 						});
 			}
 		}
-		calculateOauth2RedirectUrl(uriComponentsBuilder);
+		calculateOauth2RedirectUrl(swaggerUiConfigParameters, uriComponentsBuilder);
 	}
 
 	/**
 	 * Build swagger ui url string.
 	 *
-	 * @param swaggerUiUrl the swagger ui url
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param swaggerUiUrl              the swagger ui url
 	 * @return the string
 	 */
-	protected abstract String buildUrlWithContextPath(String swaggerUiUrl);
+	protected abstract String buildUrlWithContextPath(SwaggerUiConfigParameters swaggerUiConfigParameters, String swaggerUiUrl);
 
 	/**
 	 * Gets uri components builder.
 	 *
-	 * @param sbUrl the sb url
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param sbUrl                     the sb url
 	 * @return the uri components builder
 	 */
-	protected UriComponentsBuilder getUriComponentsBuilder(String sbUrl) {
+	protected UriComponentsBuilder getUriComponentsBuilder(SwaggerUiConfigParameters swaggerUiConfigParameters, String sbUrl) {
 		UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromUriString(sbUrl);
 		if ((swaggerUiConfig.getQueryConfigEnabled() != null && swaggerUiConfig.getQueryConfigEnabled())) {
 			swaggerUiConfigParameters.getConfigParameters().entrySet().stream()
@@ -185,24 +165,27 @@ protected UriComponentsBuilder getUriComponentsBuilder(String sbUrl) {
 	/**
 	 * Calculate oauth 2 redirect url.
 	 *
-	 * @param uriComponentsBuilder the uri components builder
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param uriComponentsBuilder      the uri components builder
 	 */
-	protected abstract void calculateOauth2RedirectUrl(UriComponentsBuilder uriComponentsBuilder);
+	protected abstract void calculateOauth2RedirectUrl(SwaggerUiConfigParameters swaggerUiConfigParameters, UriComponentsBuilder uriComponentsBuilder);
 
 	/**
 	 * Calculate ui root path.
 	 *
-	 * @param sbUrls the sb urls
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param sbUrls                    the sb urls
 	 */
-	protected abstract void calculateUiRootPath(StringBuilder... sbUrls);
+	protected abstract void calculateUiRootPath(SwaggerUiConfigParameters swaggerUiConfigParameters,StringBuilder... sbUrls);
 
 	/**
 	 * Calculate ui root common.
 	 *
-	 * @param sbUrl the sb url
-	 * @param sbUrls the sb urls
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param sbUrl                     the sb url
+	 * @param sbUrls                    the sb urls
 	 */
-	protected void calculateUiRootCommon(StringBuilder sbUrl, StringBuilder[] sbUrls) {
+	protected void calculateUiRootCommon(SwaggerUiConfigParameters swaggerUiConfigParameters, StringBuilder sbUrl, StringBuilder[] sbUrls) {
 		if (ArrayUtils.isNotEmpty(sbUrls))
 			sbUrl = sbUrls[0];
 		String swaggerPath = swaggerUiConfigParameters.getPath();
@@ -214,16 +197,16 @@ protected void calculateUiRootCommon(StringBuilder sbUrl, StringBuilder[] sbUrls
 	/**
 	 * Build api doc url string.
 	 *
-	 * @return the string
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
 	 */
-	protected abstract String buildApiDocUrl();
+	protected abstract void buildApiDocUrl(SwaggerUiConfigParameters swaggerUiConfigParameters);
 
 	/**
 	 * Build swagger config url string.
 	 *
-	 * @return the string
+	 * @param swaggerUiConfigParameters the swagger ui config parameters
 	 */
-	protected abstract String buildSwaggerConfigUrl();
+	protected abstract void buildSwaggerConfigUrl(SwaggerUiConfigParameters swaggerUiConfigParameters);
 
 	/**
 	 * Gets oauth2 redirect url.