Skip to content

Commit e3b4311

Browse files
bnasslahsenbnasslahsen
committed
PR review
1 parent bb0405c commit e3b4311

File tree

17 files changed

+106
-91
lines changed

17 files changed

+106
-91
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ public final class Constants {
175175
/**
176176
* The constant DEFAULT_WEB_JARS_PREFIX_URL.
177177
*/
178-
public static final String DEFAULT_WEB_JARS_PREFIX_URL = "/webjars/swagger-ui/5.18.2";
178+
public static final String DEFAULT_WEB_JARS_PREFIX_URL = "/webjars";
179179

180180
/**
181181
* The constant CLASSPATH_RESOURCE_LOCATION.

‎springdoc-openapi-starter-webflux-api/src/main/java/org/springdoc/webflux/core/providers/SpringWebFluxProvider.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,17 @@
2525
*/
2626
package org.springdoc.webflux.core.providers;
2727

28+
import java.util.Collection;
29+
import java.util.LinkedHashMap;
30+
import java.util.Map;
31+
import java.util.Map.Entry;
32+
import java.util.Set;
33+
import java.util.stream.Collectors;
34+
2835
import org.apache.commons.lang3.StringUtils;
2936
import org.springdoc.core.properties.SpringDocConfigProperties;
3037
import org.springdoc.core.providers.SpringWebProvider;
31-
import org.springdoc.core.utils.Constants;
38+
3239
import org.springframework.util.CollectionUtils;
3340
import org.springframework.web.method.HandlerMethod;
3441
import org.springframework.web.reactive.result.condition.PatternsRequestCondition;
@@ -37,13 +44,6 @@
3744
import org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping;
3845
import org.springframework.web.util.pattern.PathPattern;
3946

40-
import java.util.Collection;
41-
import java.util.LinkedHashMap;
42-
import java.util.Map;
43-
import java.util.Map.Entry;
44-
import java.util.Set;
45-
import java.util.stream.Collectors;
46-
4747

4848
/**
4949
* The type Spring webflux provider.
@@ -66,8 +66,8 @@ public String findPathPrefix(SpringDocConfigProperties springDocConfigProperties
6666
Set<String> patterns = getActivePatterns(requestMappingInfo);
6767
if (!CollectionUtils.isEmpty(patterns)) {
6868
for (String operationPath : patterns) {
69-
if (operationPath.endsWith(Constants.DEFAULT_API_DOCS_URL))
70-
return operationPath.replace(Constants.DEFAULT_API_DOCS_URL, StringUtils.EMPTY);
69+
if (operationPath.endsWith(springDocConfigProperties.getApiDocs().getPath()))
70+
return operationPath.replace(springDocConfigProperties.getApiDocs().getPath(), StringUtils.EMPTY);
7171
}
7272
}
7373
}

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ SwaggerUiHome swaggerUiHome(Optional<WebFluxProperties> optionalWebFluxPropertie
128128
@ConditionalOnMissingBean
129129
@Lazy(false)
130130
SwaggerWebFluxConfigurer swaggerWebFluxConfigurer(SwaggerUiConfigProperties swaggerUiConfigProperties,
131-
SpringDocConfigProperties springDocConfigProperties, SwaggerIndexTransformer swaggerIndexTransformer,
131+
SpringDocConfigProperties springDocConfigProperties, SwaggerIndexTransformer swaggerIndexTransformer,
132132
Optional<ActuatorProvider> actuatorProvider, SwaggerResourceResolver swaggerResourceResolver) {
133133
return new SwaggerWebFluxConfigurer(swaggerUiConfigProperties, springDocConfigProperties, swaggerIndexTransformer, actuatorProvider, swaggerResourceResolver);
134134
}
@@ -198,14 +198,13 @@ static class SwaggerActuatorWelcomeConfiguration {
198198
* @param swaggerUiConfig the swagger ui config
199199
* @param springDocConfigProperties the spring doc config properties
200200
* @param webEndpointProperties the web endpoint properties
201-
* @param managementServerProperties the management server properties
202201
* @return the swagger welcome actuator
203202
*/
204203
@Bean
205204
@ConditionalOnMissingBean
206205
@Lazy(false)
207206
SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties,
208-
WebEndpointProperties webEndpointProperties, ManagementServerProperties managementServerProperties) {
207+
WebEndpointProperties webEndpointProperties) {
209208
return new SwaggerWelcomeActuator(swaggerUiConfig, springDocConfigProperties, webEndpointProperties);
210209
}
211210
}

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,18 @@
2626

2727
package org.springdoc.webflux.ui;
2828

29+
import java.util.Optional;
30+
2931
import org.springdoc.core.properties.SpringDocConfigProperties;
3032
import org.springdoc.core.properties.SwaggerUiConfigProperties;
3133
import org.springdoc.core.providers.ActuatorProvider;
34+
3235
import org.springframework.web.reactive.config.ResourceHandlerRegistry;
3336
import org.springframework.web.reactive.config.WebFluxConfigurer;
3437

35-
import java.util.Optional;
36-
3738
import static org.springdoc.core.utils.Constants.ALL_PATTERN;
3839
import static org.springdoc.core.utils.Constants.CLASSPATH_RESOURCE_LOCATION;
40+
import static org.springdoc.core.utils.Constants.DEFAULT_WEB_JARS_PREFIX_URL;
3941
import static org.springdoc.core.utils.Constants.SWAGGER_UI_PREFIX;
4042
import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
4143

@@ -81,8 +83,8 @@ public class SwaggerWebFluxConfigurer implements WebFluxConfigurer {
8183
* @param swaggerResourceResolver the swagger resource resolver
8284
*/
8385
public SwaggerWebFluxConfigurer(SwaggerUiConfigProperties swaggerUiConfigProperties,
84-
SpringDocConfigProperties springDocConfigProperties,
85-
SwaggerIndexTransformer swaggerIndexTransformer,
86+
SpringDocConfigProperties springDocConfigProperties,
87+
SwaggerIndexTransformer swaggerIndexTransformer,
8688
Optional<ActuatorProvider> actuatorProvider, SwaggerResourceResolver swaggerResourceResolver) {
8789
this.swaggerIndexTransformer = swaggerIndexTransformer;
8890
this.actuatorProvider = actuatorProvider;
@@ -100,8 +102,19 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) {
100102
if (actuatorProvider.isPresent() && actuatorProvider.get().isUseManagementPort())
101103
uiRootPath.append(actuatorProvider.get().getBasePath());
102104

103-
registry.addResourceHandler(uiRootPath + SWAGGER_UI_PREFIX + ALL_PATTERN)
104-
.addResourceLocations(CLASSPATH_RESOURCE_LOCATION + springDocConfigProperties.getWebjars().getPrefix() + DEFAULT_PATH_SEPARATOR)
105+
String webjarsPrefix = springDocConfigProperties.getWebjars().getPrefix();
106+
String resourcePath,swaggerUiPrefix;
107+
108+
if (DEFAULT_WEB_JARS_PREFIX_URL.equals(webjarsPrefix)) {
109+
swaggerUiPrefix = SWAGGER_UI_PREFIX;
110+
resourcePath = webjarsPrefix + SWAGGER_UI_PREFIX + DEFAULT_PATH_SEPARATOR + swaggerUiConfigProperties.getVersion();
111+
} else {
112+
swaggerUiPrefix = webjarsPrefix;
113+
resourcePath = DEFAULT_WEB_JARS_PREFIX_URL + DEFAULT_PATH_SEPARATOR;
114+
}
115+
116+
registry.addResourceHandler(uiRootPath + swaggerUiPrefix + ALL_PATTERN)
117+
.addResourceLocations(CLASSPATH_RESOURCE_LOCATION + resourcePath)
105118
.resourceChain(false)
106119
.addResolver(swaggerResourceResolver)
107120
.addTransformer(swaggerIndexTransformer);

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ public Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse res
102102
@GetMapping(value = SWAGGER_CONFIG_ACTUATOR_URL, produces = MediaType.APPLICATION_JSON_VALUE)
103103
@ResponseBody
104104
@Override
105-
public Map<String, Object> openapiJson(ServerHttpRequest request) {
106-
return super.openapiJson(request);
105+
public Map<String, Object> getSwaggerUiConfig(ServerHttpRequest request) {
106+
return super.getSwaggerUiConfig(request);
107107
}
108108

109109
@Override

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

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,22 @@
2626

2727
package org.springdoc.webflux.ui;
2828

29+
import java.net.URI;
30+
import java.util.Map;
31+
2932
import org.apache.commons.lang3.StringUtils;
3033
import org.springdoc.core.properties.SpringDocConfigProperties;
3134
import org.springdoc.core.properties.SwaggerUiConfigParameters;
3235
import org.springdoc.core.properties.SwaggerUiConfigProperties;
3336
import org.springdoc.ui.AbstractSwaggerWelcome;
37+
import reactor.core.publisher.Mono;
38+
3439
import org.springframework.http.HttpStatus;
3540
import org.springframework.http.server.reactive.ServerHttpRequest;
3641
import org.springframework.http.server.reactive.ServerHttpResponse;
3742
import org.springframework.web.util.UriComponentsBuilder;
38-
import reactor.core.publisher.Mono;
3943

40-
import java.net.URI;
41-
import java.util.Map;
44+
import static org.springdoc.core.utils.Constants.DEFAULT_WEB_JARS_PREFIX_URL;
4245

4346
/**
4447
* The type Swagger welcome common.
@@ -68,35 +71,33 @@ protected SwaggerWelcomeCommon(SwaggerUiConfigProperties swaggerUiConfig, Spring
6871
protected Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse response) {
6972
SwaggerUiConfigParameters swaggerUiConfigParameters = new SwaggerUiConfigParameters(swaggerUiConfig);
7073
buildFromCurrentContextPath(swaggerUiConfigParameters, request);
71-
String sbUrl = swaggerUiConfigParameters.getContextPath() + swaggerUiConfigParameters.getUiRootPath() + getSwaggerUiUrl();
74+
String webjarsPrefix = springDocConfigProperties.getWebjars().getPrefix();
75+
String additionalPrefix = DEFAULT_WEB_JARS_PREFIX_URL.equals(webjarsPrefix) ? "" : webjarsPrefix;
76+
String sbUrl = swaggerUiConfigParameters.getContextPath()
77+
+ swaggerUiConfigParameters.getUiRootPath()
78+
+ additionalPrefix
79+
+ getSwaggerUiUrl();
7280
UriComponentsBuilder uriBuilder = getUriComponentsBuilder(swaggerUiConfigParameters, sbUrl);
73-
7481
// forward all queryParams from original request
7582
request.getQueryParams().forEach(uriBuilder::queryParam);
76-
7783
response.setStatusCode(HttpStatus.FOUND);
7884
response.getHeaders().setLocation(URI.create(uriBuilder.build().encode().toString()));
7985
return response.setComplete();
8086
}
8187

82-
/**
83-
* Openapi json map.
84-
*
85-
* @param request the request
86-
* @return the map
87-
*/
88-
protected Map<String, Object> openapiJson(ServerHttpRequest request) {
89-
SwaggerUiConfigParameters swaggerUiConfigParameters = new SwaggerUiConfigParameters(swaggerUiConfig);
90-
buildFromCurrentContextPath(swaggerUiConfigParameters, request);
91-
return swaggerUiConfigParameters.getConfigParameters();
92-
}
93-
9488
@Override
9589
protected void calculateOauth2RedirectUrl(SwaggerUiConfigParameters swaggerUiConfigParameters, UriComponentsBuilder uriComponentsBuilder) {
9690
if (StringUtils.isBlank(swaggerUiConfig.getOauth2RedirectUrl()) || !swaggerUiConfigParameters.isValidUrl(swaggerUiConfig.getOauth2RedirectUrl())) {
97-
swaggerUiConfigParameters.setOauth2RedirectUrl(uriComponentsBuilder
98-
.path(swaggerUiConfigParameters.getUiRootPath())
99-
.path(getOauth2RedirectUrl()).build().toString());
91+
String webjarsPrefix = springDocConfigProperties.getWebjars().getPrefix();
92+
String additionalPath = DEFAULT_WEB_JARS_PREFIX_URL.equals(webjarsPrefix) ? "" : webjarsPrefix;
93+
swaggerUiConfigParameters.setOauth2RedirectUrl(
94+
uriComponentsBuilder
95+
.path(swaggerUiConfigParameters.getUiRootPath())
96+
.path(additionalPath)
97+
.path(getOauth2RedirectUrl())
98+
.build()
99+
.toString()
100+
);
100101
}
101102
}
102103

‎springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractSpringDocTest.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import org.springdoc.core.utils.Constants;
2828
import org.springdoc.webflux.core.configuration.SpringDocWebFluxConfiguration;
2929
import org.springdoc.webflux.ui.SwaggerConfig;
30+
3031
import org.springframework.beans.factory.annotation.Autowired;
3132
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
3233
import org.springframework.test.context.ContextConfiguration;

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,16 @@
2626

2727
import jakarta.annotation.PostConstruct;
2828
import org.junit.jupiter.api.Test;
29+
import reactor.core.publisher.Mono;
30+
import test.org.springdoc.ui.AbstractCommonTest;
31+
2932
import org.springframework.boot.autoconfigure.SpringBootApplication;
3033
import org.springframework.boot.test.context.SpringBootTest;
3134
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
3235
import org.springframework.boot.test.web.server.LocalServerPort;
3336
import org.springframework.http.HttpStatus;
3437
import org.springframework.http.HttpStatusCode;
3538
import org.springframework.web.reactive.function.client.WebClient;
36-
import reactor.core.publisher.Mono;
37-
import test.org.springdoc.ui.AbstractCommonTest;
3839

3940
import static org.assertj.core.api.Assertions.assertThat;
4041
import static org.skyscreamer.jsonassert.JSONAssert.assertEquals;
@@ -44,7 +45,8 @@
4445
properties = { "spring.webflux.base-path=/test",
4546
"server.port=9218",
4647
"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
47-
"springdoc.api-docs.path=/documentation/v3/api-docs"})
48+
"springdoc.api-docs.path=/documentation/v3/api-docs",
49+
"springdoc.webjars.prefix= /webjars-pref" })
4850
class SpringDocApp18Test extends AbstractCommonTest {
4951

5052
@LocalServerPort
@@ -64,7 +66,7 @@ void testIndex() throws Exception {
6466
.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
6567
assertThat(httpStatusMono).isEqualTo(HttpStatus.FOUND);
6668

67-
httpStatusMono = webClient.get().uri("/test/documentation/swagger-ui/index.html")
69+
httpStatusMono = webClient.get().uri("/test/documentation/webjars-pref/swagger-ui/index.html")
6870
.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
6971
assertThat(httpStatusMono).isEqualTo(HttpStatus.OK);
7072

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,16 @@
2020

2121
import org.hamcrest.Matchers;
2222
import org.junit.jupiter.api.Test;
23+
import test.org.springdoc.ui.AbstractSpringDocTest;
24+
2325
import org.springframework.boot.autoconfigure.SpringBootApplication;
2426
import org.springframework.test.context.TestPropertySource;
2527
import org.springframework.test.web.reactive.server.WebTestClient;
26-
import test.org.springdoc.ui.AbstractSpringDocTest;
2728

2829
@TestPropertySource(properties = {
2930
"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
30-
"springdoc.api-docs.path=/documentation/v3/api-docs"
31+
"springdoc.api-docs.path=/documentation/v3/api-docs",
32+
"springdoc.webjars.prefix= /webjars-pref"
3133
})
3234
public class SpringDocApp3RedirectWithPrefixTest extends AbstractSpringDocTest {
3335

@@ -36,8 +38,8 @@ void shouldRedirectWithPrefix() {
3638
WebTestClient.ResponseSpec responseSpec = webTestClient.get().uri("/documentation/swagger-ui.html").exchange()
3739
.expectStatus().isFound();
3840
responseSpec.expectHeader()
39-
.value("Location", Matchers.is("/documentation/swagger-ui/index.html"));
40-
webTestClient.get().uri("/documentation/swagger-ui/index.html").exchange()
41+
.value("Location", Matchers.is("/documentation/webjars-pref/swagger-ui/index.html"));
42+
webTestClient.get().uri("/documentation/webjars-pref/swagger-ui/index.html").exchange()
4143
.expectStatus().isOk();
4244
webTestClient.get().uri("/documentation/v3/api-docs/swagger-config").exchange()
4345
.expectStatus().isOk().expectBody().jsonPath("$.validatorUrl").isEqualTo("");

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@
4040
"server.forward-headers-strategy=framework",
4141
"server.port=9318",
4242
"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
43-
"springdoc.api-docs.path=/documentation/v3/api-docs"})
43+
"springdoc.api-docs.path=/documentation/v3/api-docs",
44+
"springdoc.webjars.prefix= /webjars-pref" })
4445

4546
@Import(SpringDocConfig.class)
4647
public class SpringDocBehindProxyBasePathTest extends AbstractCommonTest {
@@ -66,7 +67,7 @@ void testIndex() throws Exception {
6667
.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
6768
assertThat(httpStatusMono).isEqualTo(HttpStatus.FOUND);
6869

69-
httpStatusMono = webClient.get().uri(WEBFLUX_BASE_PATH + "/documentation/swagger-ui/index.html")
70+
httpStatusMono = webClient.get().uri(WEBFLUX_BASE_PATH+"/documentation/webjars-pref/swagger-ui/index.html")
7071
.header("X-Forwarded-Prefix", X_FORWARD_PREFIX)
7172
.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
7273
assertThat(httpStatusMono).isEqualTo(HttpStatus.OK);

0 commit comments

Comments
 (0)