Fix WebJar resource handler mappings for Swagger UI resources. Fixes #3146

Author: bnasslahsen

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

@@ -48,7 +48,7 @@
 public abstract class AbstractSwaggerUiConfigProperties {
 
 	/**
-	 * The path for the Swagger UI pages to load. Will redirect to the springdoc.webjars.prefix property.
+	 * The path for the Swagger UI pages to load.
 	 */
 	protected String path = Constants.DEFAULT_SWAGGER_UI_PATH;
 
@@ -814,4 +814,4 @@ public String toString() {
 		}
 	}
 
-}
+}

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java

@@ -44,7 +44,6 @@
 import org.springframework.context.annotation.Lazy;
 import org.springframework.http.MediaType;
 
-import static org.springdoc.core.utils.Constants.DEFAULT_WEB_JARS_PREFIX_URL;
 import static org.springdoc.core.utils.Constants.SPRINGDOC_ENABLED;
 
 /**
@@ -64,11 +63,6 @@ public class SpringDocConfigProperties {
 	 */
 	private boolean showActuator;
 
-	/**
-	 * The Webjars.
-	 */
-	private Webjars webjars = new Webjars();
-
 	/**
 	 * The Api docs.
 	 */
@@ -786,24 +780,6 @@ public void setShowActuator(boolean showActuator) {
 		this.showActuator = showActuator;
 	}
 
-	/**
-	 * Gets webjars.
-	 *
-	 * @return the webjars
-	 */
-	public Webjars getWebjars() {
-		return webjars;
-	}
-
-	/**
-	 * Sets webjars.
-	 *
-	 * @param webjars the webjars
-	 */
-	public void setWebjars(Webjars webjars) {
-		this.webjars = webjars;
-	}
-
 	/**
 	 * Gets api docs.
 	 *
@@ -1390,36 +1366,6 @@ public void setEnabled(boolean enabled) {
 		}
 	}
 
-	/**
-	 * The type Webjars.
-	 *
-	 * @author bnasslahsen
-	 */
-	public static class Webjars {
-		/**
-		 * The Prefix.
-		 */
-		private String prefix = DEFAULT_WEB_JARS_PREFIX_URL;
-
-		/**
-		 * Gets prefix.
-		 *
-		 * @return the prefix
-		 */
-		public String getPrefix() {
-			return prefix;
-		}
-
-		/**
-		 * Sets prefix.
-		 *
-		 * @param prefix the prefix
-		 */
-		public void setPrefix(String prefix) {
-			this.prefix = prefix;
-		}
-	}
-
 	/**
 	 * The type Api docs.
 	 *

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/Constants.java

@@ -26,9 +26,8 @@
 
 package org.springdoc.core.utils;
 
-import org.springframework.util.ResourceUtils;
-
 import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
+import static org.springframework.util.ResourceUtils.CLASSPATH_URL_PREFIX;
 
 /**
  * The type Constants.
@@ -70,7 +69,7 @@ public final class Constants {
 	/**
 	 * The constant SWAGGER_CONFIG_URL.
 	 */
-	public static final String SWAGGER_CONFIG_URL = API_DOCS_URL + DEFAULT_PATH_SEPARATOR + SWAGGER_CONFIG_FILE;
+	public static final String SWAGGER_CONFIG_URL = API_DOCS_URL + "/" + SWAGGER_CONFIG_FILE;
 
 	/**
 	 * The constant YAML.
@@ -178,20 +177,24 @@ public final class Constants {
 	public static final String SPRINGDOC_ACTUATOR_DOC_DESCRIPTION = "Spring Boot Actuator Web API Documentation";
 
 	/**
-	 * The constant DEFAULT_WEB_JARS_PREFIX_URL.
+	 * The constant CLASSPATH_RESOURCE_LOCATION.
 	 */
-	public static final String DEFAULT_WEB_JARS_PREFIX_URL = "/webjars";
+	public static final String CLASSPATH_RESOURCE_LOCATION = CLASSPATH_URL_PREFIX + "META-INF" + DEFAULT_PATH_SEPARATOR + "resources" + DEFAULT_PATH_SEPARATOR;
 
 	/**
-	 * The constant CLASSPATH_RESOURCE_LOCATION.
+	 * The constant WEBJARS_RESOURCE_LOCATION.
 	 */
-	public static final String CLASSPATH_RESOURCE_LOCATION = ResourceUtils.CLASSPATH_URL_PREFIX + "/META-INF/resources";
+	public static final String WEBJARS_RESOURCE_LOCATION = CLASSPATH_RESOURCE_LOCATION + "webjars" + DEFAULT_PATH_SEPARATOR;
 
+	/**
+	 * The constant SWAGGER_UI_WEBJAR_NAME.
+	 */
+	public static final String SWAGGER_UI_WEBJAR_NAME = "swagger-ui";
 
 	/**
 	 * The constant SWAGGER_UI_PREFIX.
 	 */
-	public static final String SWAGGER_UI_PREFIX = "/swagger-ui";
+	public static final String SWAGGER_UI_PREFIX = "/" + SWAGGER_UI_WEBJAR_NAME;
 
 	/**
 	 * The constant INDEX_PAGE.
@@ -231,7 +234,7 @@ public final class Constants {
 	/**
 	 * The constant DEFAULT_SWAGGER_UI_PATH.
 	 */
-	public static final String DEFAULT_SWAGGER_UI_PATH = DEFAULT_PATH_SEPARATOR + "swagger-ui.html";
+	public static final String DEFAULT_SWAGGER_UI_PATH = "/swagger-ui.html";
 
 	/**
 	 * The constant SWAGGER_UI_PATH.
@@ -363,6 +366,21 @@ public final class Constants {
 	 */
 	public static final String ALL_PATTERN = "/**";
 
+	/**
+	 * The constant SWAGGER_UI_WEBJAR_NAME_PATTERN.
+	 */
+	public static final String SWAGGER_UI_WEBJAR_NAME_PATTERN = "/*" + SWAGGER_UI_WEBJAR_NAME;
+
+	/**
+	 * The constant SWAGGER_INITIALIZER_PATTERN.
+	 */
+	public static final String SWAGGER_INITIALIZER_PATTERN = "/*" + SWAGGER_INITIALIZER_JS;
+
+	/**
+	 * The constant SWAGGER_RESOURCE_CACHE_NAME.
+	 */
+	public static final String SWAGGER_RESOURCE_CACHE_NAME = "swagger-resource-chain-cache";
+
 	/**
 	 * The constant HEALTH_PATTERN.
 	 */
@@ -397,7 +415,7 @@ public final class Constants {
 	/**
 	 * The constant DEFAULT_YAML_API_DOCS_ACTUATOR_PATH.
 	 */
-	public static final String DEFAULT_YAML_API_DOCS_ACTUATOR_PATH = DEFAULT_PATH_SEPARATOR + YAML;
+	public static final String DEFAULT_YAML_API_DOCS_ACTUATOR_PATH = "/" + YAML;
 
 	/**
 	 * The constant ACTUATOR_DEFAULT_GROUP.