Remove springdoc.webjars.prefix property

Author: jamesmissen

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-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerWebFluxConfigurer.java

@@ -32,12 +32,13 @@
 import org.springdoc.core.properties.SwaggerUiConfigProperties;
 import org.springdoc.core.providers.ActuatorProvider;
 
+import org.springframework.http.CacheControl;
 import org.springframework.web.reactive.config.ResourceHandlerRegistry;
 import org.springframework.web.reactive.config.WebFluxConfigurer;
 
-import static org.springdoc.core.utils.Constants.ALL_PATTERN;
 import static org.springdoc.core.utils.Constants.CLASSPATH_RESOURCE_LOCATION;
 import static org.springdoc.core.utils.Constants.DEFAULT_WEB_JARS_PREFIX_URL;
+import static org.springdoc.core.utils.Constants.SWAGGER_INITIALIZER_JS;
 import static org.springdoc.core.utils.Constants.SWAGGER_UI_PREFIX;
 import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
 
@@ -102,28 +103,15 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) {
 		if (actuatorProvider.isPresent() && actuatorProvider.get().isUseManagementPort())
 			uiRootPath.append(actuatorProvider.get().getBasePath());
 
-		String webjarsPrefix = springDocConfigProperties.getWebjars().getPrefix();
-		String resourcePath, swaggerUiPrefix, swaggerUiWebjarsPrefix;
-
-		if (DEFAULT_WEB_JARS_PREFIX_URL.equals(webjarsPrefix)) {
-			swaggerUiPrefix = SWAGGER_UI_PREFIX;
-			resourcePath = webjarsPrefix + SWAGGER_UI_PREFIX + DEFAULT_PATH_SEPARATOR + swaggerUiConfigProperties.getVersion() + DEFAULT_PATH_SEPARATOR;
-			swaggerUiWebjarsPrefix = webjarsPrefix + swaggerUiPrefix;
-		}
-		else {
-			swaggerUiPrefix = webjarsPrefix;
-			resourcePath = DEFAULT_WEB_JARS_PREFIX_URL + DEFAULT_PATH_SEPARATOR;
-			swaggerUiWebjarsPrefix = swaggerUiPrefix;
-		}
-
-		registry.addResourceHandler(uiRootPath + swaggerUiWebjarsPrefix + ALL_PATTERN)
-				.addResourceLocations(CLASSPATH_RESOURCE_LOCATION + resourcePath)
+		registry.addResourceHandler(uiRootPath + SWAGGER_UI_PREFIX + "*/*" + SWAGGER_INITIALIZER_JS)
+				.addResourceLocations(CLASSPATH_RESOURCE_LOCATION + DEFAULT_WEB_JARS_PREFIX_URL + DEFAULT_PATH_SEPARATOR)
+				.setCacheControl(CacheControl.noStore())
 				.resourceChain(false)
 				.addResolver(swaggerResourceResolver)
 				.addTransformer(swaggerIndexTransformer);
 
-		registry.addResourceHandler(uiRootPath + swaggerUiPrefix + ALL_PATTERN)
-				.addResourceLocations(CLASSPATH_RESOURCE_LOCATION + resourcePath)
+		registry.addResourceHandler(uiRootPath + SWAGGER_UI_PREFIX + "*/**")
+				.addResourceLocations(CLASSPATH_RESOURCE_LOCATION + DEFAULT_WEB_JARS_PREFIX_URL + DEFAULT_PATH_SEPARATOR)
 				.resourceChain(false)
 				.addResolver(swaggerResourceResolver)
 				.addTransformer(swaggerIndexTransformer);

springdoc-openapi-starter-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerWelcomeCommon.java

@@ -42,8 +42,6 @@
 import org.springframework.web.util.ForwardedHeaderUtils;
 import org.springframework.web.util.UriComponentsBuilder;
 
-import static org.springdoc.core.utils.Constants.DEFAULT_WEB_JARS_PREFIX_URL;
-
 /**
  * The type Swagger welcome common.
  *
@@ -72,15 +70,12 @@ protected SwaggerWelcomeCommon(SwaggerUiConfigProperties swaggerUiConfig, Spring
 	protected Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse response) {
 		SwaggerUiConfigParameters swaggerUiConfigParameters = new SwaggerUiConfigParameters(swaggerUiConfig);
 		buildFromCurrentContextPath(swaggerUiConfigParameters, request);
-		String webjarsPrefix = springDocConfigProperties.getWebjars().getPrefix();
-		String additionalPrefix = DEFAULT_WEB_JARS_PREFIX_URL.equals(webjarsPrefix) ? "" : webjarsPrefix;
-		String sbUrl = swaggerUiConfigParameters.getContextPath()
-				+ swaggerUiConfigParameters.getUiRootPath()
-				+ additionalPrefix
-				+ getSwaggerUiUrl();
+		String sbUrl = swaggerUiConfigParameters.getContextPath() + swaggerUiConfigParameters.getUiRootPath() + getSwaggerUiUrl();
 		UriComponentsBuilder uriBuilder = getUriComponentsBuilder(swaggerUiConfigParameters, sbUrl);
+
 		// forward all queryParams from original request
 		request.getQueryParams().forEach(uriBuilder::queryParam);
+
 		response.setStatusCode(HttpStatus.FOUND);
 		response.getHeaders().setLocation(URI.create(uriBuilder.build().encode().toString()));
 		return response.setComplete();
@@ -89,16 +84,9 @@ protected Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse
 	@Override
 	protected void calculateOauth2RedirectUrl(SwaggerUiConfigParameters swaggerUiConfigParameters, UriComponentsBuilder uriComponentsBuilder) {
 		if (StringUtils.isBlank(swaggerUiConfig.getOauth2RedirectUrl()) || !swaggerUiConfigParameters.isValidUrl(swaggerUiConfig.getOauth2RedirectUrl())) {
-			String webjarsPrefix = springDocConfigProperties.getWebjars().getPrefix();
-			String additionalPath = DEFAULT_WEB_JARS_PREFIX_URL.equals(webjarsPrefix) ? "" : webjarsPrefix;
-			swaggerUiConfigParameters.setOauth2RedirectUrl(
-					uriComponentsBuilder
-							.path(swaggerUiConfigParameters.getUiRootPath())
-							.path(additionalPath)
-							.path(getOauth2RedirectUrl())
-							.build()
-							.toString()
-			);
+			swaggerUiConfigParameters.setOauth2RedirectUrl(uriComponentsBuilder
+					.path(swaggerUiConfigParameters.getUiRootPath())
+					.path(getOauth2RedirectUrl()).build().toString());
 		}
 	}
 

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app18/SpringDocApp18Test.java

@@ -45,8 +45,7 @@
 		properties = { "spring.webflux.base-path=/test",
 				"server.port=9218",
 				"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
-				"springdoc.api-docs.path=/documentation/v3/api-docs",
-				"springdoc.webjars.prefix= /webjars-pref" })
+				"springdoc.api-docs.path=/documentation/v3/api-docs" })
 class SpringDocApp18Test extends AbstractCommonTest {
 
 	@LocalServerPort
@@ -66,7 +65,7 @@ void testIndex() throws Exception {
 				.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
 		assertThat(httpStatusMono).isEqualTo(HttpStatus.FOUND);
 
-		httpStatusMono = webClient.get().uri("/test/documentation/webjars-pref/swagger-ui/index.html")
+		httpStatusMono = webClient.get().uri("/test/documentation/swagger-ui/index.html")
 				.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
 		assertThat(httpStatusMono).isEqualTo(HttpStatus.OK);
 

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app3/SpringDocApp3RedirectWithPrefixTest.java

@@ -28,8 +28,7 @@
 
 @TestPropertySource(properties = {
 		"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
-		"springdoc.api-docs.path=/documentation/v3/api-docs",
-		"springdoc.webjars.prefix= /webjars-pref"
+		"springdoc.api-docs.path=/documentation/v3/api-docs"
 })
 public class SpringDocApp3RedirectWithPrefixTest extends AbstractSpringDocTest {
 
@@ -38,8 +37,8 @@ void shouldRedirectWithPrefix() {
 		WebTestClient.ResponseSpec responseSpec = webTestClient.get().uri("/documentation/swagger-ui.html").exchange()
 				.expectStatus().isFound();
 		responseSpec.expectHeader()
-				.value("Location", Matchers.is("/documentation/webjars-pref/swagger-ui/index.html"));
-		webTestClient.get().uri("/documentation/webjars-pref/swagger-ui/index.html").exchange()
+				.value("Location", Matchers.is("/documentation/swagger-ui/index.html"));
+		webTestClient.get().uri("/documentation/swagger-ui/index.html").exchange()
 				.expectStatus().isOk();
 		webTestClient.get().uri("/documentation/v3/api-docs/swagger-config").exchange()
 				.expectStatus().isOk().expectBody().jsonPath("$.validatorUrl").isEqualTo("");

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app33/SpringDocBehindProxyBasePathTest.java

@@ -41,8 +41,7 @@
 				"server.forward-headers-strategy=framework",
 				"server.port=9318",
 				"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
-				"springdoc.api-docs.path=/documentation/v3/api-docs",
-				"springdoc.webjars.prefix= /webjars-pref" })
+				"springdoc.api-docs.path=/documentation/v3/api-docs" })
 
 @Import(SpringDocConfig.class)
 public class SpringDocBehindProxyBasePathTest extends AbstractCommonTest {
@@ -69,7 +68,7 @@ void testIndex() throws Exception {
 				.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
 		assertThat(httpStatusMono).isEqualTo(HttpStatus.FOUND);
 
-		httpStatusMono = webClient.get().uri(WEBFLUX_BASE_PATH + "/documentation/webjars-pref/swagger-ui/index.html")
+		httpStatusMono = webClient.get().uri(WEBFLUX_BASE_PATH + "/documentation/swagger-ui/index.html")
 				.header("X-Forwarded-Prefix", X_FORWARD_PREFIX)
 				.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
 		assertThat(httpStatusMono).isEqualTo(HttpStatus.OK);

springdoc-openapi-starter-webflux-ui/src/test/resources/results/app18-1.json

@@ -1,6 +1,6 @@
 {
   "configUrl": "/test/documentation/v3/api-docs/swagger-config",
-  "oauth2RedirectUrl": "http://localhost:9218/test/documentation/webjars-pref/swagger-ui/oauth2-redirect.html",
+  "oauth2RedirectUrl": "http://localhost:9218/test/documentation/swagger-ui/oauth2-redirect.html",
   "urls": [
     {
       "url": "/test/documentation/v3/api-docs/users",

springdoc-openapi-starter-webflux-ui/src/test/resources/results/app32-1.json

@@ -1,6 +1,6 @@
 {
   "configUrl": "/path/prefix/documentation/v3/api-docs/swagger-config",
-  "oauth2RedirectUrl": "http://localhost:9318/path/prefix/documentation/webjars-pref/swagger-ui/oauth2-redirect.html",
+  "oauth2RedirectUrl": "http://localhost:9318/path/prefix/documentation/swagger-ui/oauth2-redirect.html",
   "url": "/path/prefix/documentation/v3/api-docs",
   "validatorUrl": ""
 }

springdoc-openapi-starter-webflux-ui/src/test/resources/results/app33.json

@@ -1,6 +1,6 @@
 {
   "configUrl": "/path/prefix/test/documentation/v3/api-docs/swagger-config",
-  "oauth2RedirectUrl": "http://localhost:9318/path/prefix/test/documentation/webjars-pref/swagger-ui/oauth2-redirect.html",
+  "oauth2RedirectUrl": "http://localhost:9318/path/prefix/test/documentation/swagger-ui/oauth2-redirect.html",
   "url": "/path/prefix/test/documentation/v3/api-docs",
   "validatorUrl": ""
 }