Skip to content

Commit 7e50c6f

Browse files
bnasslahsenbnasslahsen
committed
UPGRADE swagger-ui to 3.37.2 + code cleanup
1 parent 3e43d72 commit 7e50c6f

File tree

13 files changed

+34
-40
lines changed

13 files changed

+34
-40
lines changed

‎pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
6868
<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
6969
<swagger-api.version>2.1.5</swagger-api.version>
70-
<swagger-ui.version>3.37.0</swagger-ui.version>
70+
<swagger-ui.version>3.37.2</swagger-ui.version>
7171
<spring-security-oauth2.version>2.3.8.RELEASE</spring-security-oauth2.version>
7272
<classgraph.version>4.8.69</classgraph.version>
7373
<webjars-locator-core.version>0.45</webjars-locator-core.version>

‎springdoc-openapi-common/src/main/java/org/springdoc/core/ActuatorProvider.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636
import org.springframework.context.ApplicationListener;
3737
import org.springframework.util.AntPathMatcher;
3838

39+
import static org.apache.commons.lang3.StringUtils.EMPTY;
40+
3941

4042
/**
4143
* The type Actuator provider.
@@ -162,7 +164,7 @@ public String getBasePath() {
162164
* @return the context path
163165
*/
164166
public String getContextPath() {
165-
return "";
167+
return EMPTY;
166168
}
167169

168170
/**

‎springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@
5252
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
5353
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
5454
import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
55+
import org.springframework.boot.actuate.autoconfigure.web.server.ConditionalOnManagementPort;
56+
import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
5557
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
5658
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
5759
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
@@ -358,8 +360,21 @@ public ResponseEntity<ErrorMessage> handleNoHandlerFound(OpenApiResourceNotFound
358360
*/
359361
@ConditionalOnClass(WebEndpointProperties.class)
360362
@ConditionalOnProperty(SPRINGDOC_SHOW_ACTUATOR)
361-
static class SpringDocWebMvcActuatorConfiguration {
363+
static class SpringDocActuatorConfiguration {
362364

365+
/**
366+
* Springdoc bean factory post processor 3 bean factory post processor.
367+
*
368+
* @param groupedOpenApis the grouped open apis
369+
* @return the bean factory post processor
370+
*/
371+
@Bean
372+
@Lazy(false)
373+
@ConditionalOnManagementPort(ManagementPortType.DIFFERENT)
374+
@Conditional(MultipleOpenApiSupportCondition.class)
375+
static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor3(List<GroupedOpenApi> groupedOpenApis) {
376+
return new SpringdocActuatorBeanFactoryConfigurer(groupedOpenApis);
377+
}
363378
/**
364379
* Actuator customizer operation customizer.
365380
*

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public SwaggerWelcomeActuator(SwaggerUiConfigProperties swaggerUiConfig, SpringD
5656
*/
5757
@Operation(hidden = true)
5858
@GetMapping(DEFAULT_PATH_SEPARATOR)
59+
@Override
5960
public String redirectToUi(HttpServletRequest request) {
6061
return super.redirectToUi(request);
6162
}
@@ -69,6 +70,7 @@ public String redirectToUi(HttpServletRequest request) {
6970
@Operation(hidden = true)
7071
@GetMapping(value = SWAGGER_CONFIG_ACTUATOR_URL, produces = MediaType.APPLICATION_JSON_VALUE)
7172
@ResponseBody
73+
@Override
7274
public Map<String, Object> openapiJson(HttpServletRequest request) {
7375
return super.openapiJson(request);
7476
}
@@ -80,7 +82,7 @@ protected void calculateUiRootPath(StringBuilder... sbUrls) {
8082
calculateUiRootCommon(sbUrl, sbUrls);
8183
}
8284

83-
85+
@Override
8486
protected void buildConfigUrl(String contextPath, UriComponentsBuilder uriComponentsBuilder) {
8587
String apiDocsUrl = DEFAULT_API_DOCS_ACTUATOR_URL;
8688
if (StringUtils.isEmpty(swaggerUiConfig.getConfigUrl())) {

‎springdoc-openapi-ui/src/main/java/org/springdoc/webmvc/ui/SwaggerWelcomeWebMvc.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ public SwaggerWelcomeWebMvc(SwaggerUiConfigProperties swaggerUiConfig, SpringDoc
7373
*/
7474
@Operation(hidden = true)
7575
@GetMapping(SWAGGER_UI_PATH)
76+
@Override
7677
public String redirectToUi(HttpServletRequest request) {
7778
return super.redirectToUi(request);
7879
}
@@ -86,6 +87,7 @@ public String redirectToUi(HttpServletRequest request) {
8687
@Operation(hidden = true)
8788
@GetMapping(value = SWAGGER_CONFIG_URL, produces = MediaType.APPLICATION_JSON_VALUE)
8889
@ResponseBody
90+
@Override
8991
public Map<String, Object> openapiJson(HttpServletRequest request) {
9092
return super.openapiJson(request);
9193
}

‎springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiActuatorResource.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest)
121121
return super.openapiYaml(serverHttpRequest, YAML);
122122
}
123123

124+
@Override
124125
protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl) {
125126
super.initOpenAPIBuilder();
126127
URI uri = getActuatorURI(serverHttpRequest.getURI().getScheme(), serverHttpRequest.getURI().getHost());

‎springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiWebfluxResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ public OpenApiWebfluxResource(ObjectFactory<OpenAPIService> openAPIBuilderObject
102102
*/
103103
@Operation(hidden = true)
104104
@GetMapping(value = API_DOCS_URL, produces = MediaType.APPLICATION_JSON_VALUE)
105+
@Override
105106
public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_DOCS_URL) String apiDocsUrl)
106107
throws JsonProcessingException {
107108
return super.openapiJson(serverHttpRequest, apiDocsUrl);
@@ -117,6 +118,7 @@ public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_
117118
*/
118119
@Operation(hidden = true)
119120
@GetMapping(value = DEFAULT_API_DOCS_URL_YAML, produces = APPLICATION_OPENAPI_YAML)
121+
@Override
120122
public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest,
121123
@Value(DEFAULT_API_DOCS_URL_YAML) String apiDocsUrl) throws JsonProcessingException {
122124
return super.openapiYaml(serverHttpRequest, apiDocsUrl);

‎springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/core/MultipleOpenApiSupportConfiguration.java

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,10 @@
3131
import org.springdoc.core.OpenAPIService;
3232
import org.springdoc.core.OperationService;
3333
import org.springdoc.core.SpringDocConfigProperties;
34-
import org.springdoc.core.SpringdocActuatorBeanFactoryConfigurer;
3534
import org.springdoc.webflux.api.MultipleOpenApiActuatorResource;
3635
import org.springdoc.webflux.api.MultipleOpenApiWebFluxResource;
3736

3837
import org.springframework.beans.factory.ObjectFactory;
39-
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
4038
import org.springframework.boot.actuate.autoconfigure.web.server.ConditionalOnManagementPort;
4139
import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
4240
import org.springframework.boot.actuate.endpoint.web.reactive.WebFluxEndpointHandlerMapping;
@@ -51,7 +49,6 @@
5149
import org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping;
5250

5351
import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
54-
import static org.springdoc.core.Constants.SPRINGDOC_SHOW_ACTUATOR;
5552
import static org.springdoc.core.Constants.SPRINGDOC_USE_MANAGEMENT_PORT;
5653

5754

@@ -105,19 +102,6 @@ MultipleOpenApiWebFluxResource multipleOpenApiResource(List<GroupedOpenApi> grou
105102
@ConditionalOnManagementPort(ManagementPortType.DIFFERENT)
106103
static class SpringDocWebMvcActuatorDifferentConfiguration {
107104

108-
/**
109-
* Springdoc bean factory post processor 3 bean factory post processor.
110-
*
111-
* @param groupedOpenApis the grouped open apis
112-
* @return the bean factory post processor
113-
*/
114-
@Bean
115-
@ConditionalOnProperty(SPRINGDOC_SHOW_ACTUATOR)
116-
@Lazy(false)
117-
static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor3(List<GroupedOpenApi> groupedOpenApis) {
118-
return new SpringdocActuatorBeanFactoryConfigurer(groupedOpenApis);
119-
}
120-
121105
/**
122106
* Multiple open api actuator resource multiple open api actuator resource.
123107
*

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ public SwaggerWelcomeActuator(SwaggerUiConfigProperties swaggerUiConfig
8686
*/
8787
@Operation(hidden = true)
8888
@GetMapping(DEFAULT_PATH_SEPARATOR)
89+
@Override
8990
public Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse response) {
9091
return super.redirectToUi(request,response);
9192
}
@@ -100,6 +101,7 @@ public Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse res
100101
@Operation(hidden = true)
101102
@GetMapping(value = SWAGGER_CONFIG_ACTUATOR_URL, produces = MediaType.APPLICATION_JSON_VALUE)
102103
@ResponseBody
104+
@Override
103105
public Map<String, Object> getSwaggerUiConfig(ServerHttpRequest request) {
104106
return super.getSwaggerUiConfig(request);
105107
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ public SwaggerWelcomeWebFlux(SwaggerUiConfigProperties swaggerUiConfig, SpringDo
6565
*/
6666
@Operation(hidden = true)
6767
@GetMapping(SWAGGER_UI_PATH)
68+
@Override
6869
public Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse response) {
6970
return super.redirectToUi(request, response);
7071
}
@@ -78,6 +79,7 @@ public Mono<Void> redirectToUi(ServerHttpRequest request, ServerHttpResponse res
7879
@Operation(hidden = true)
7980
@GetMapping(value = SWAGGER_CONFIG_URL, produces = MediaType.APPLICATION_JSON_VALUE)
8081
@ResponseBody
82+
@Override
8183
public Map<String, Object> getSwaggerUiConfig(ServerHttpRequest request) {
8284
return super.getSwaggerUiConfig(request);
8385
}

‎springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiWebMvcResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ public OpenApiWebMvcResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectF
110110
*/
111111
@Operation(hidden = true)
112112
@GetMapping(value = API_DOCS_URL, produces = MediaType.APPLICATION_JSON_VALUE)
113+
@Override
113114
public String openapiJson(HttpServletRequest request, @Value(API_DOCS_URL) String apiDocsUrl)
114115
throws JsonProcessingException {
115116
return super.openapiJson(request, apiDocsUrl);
@@ -125,6 +126,7 @@ public String openapiJson(HttpServletRequest request, @Value(API_DOCS_URL) Strin
125126
*/
126127
@Operation(hidden = true)
127128
@GetMapping(value = DEFAULT_API_DOCS_URL_YAML, produces = APPLICATION_OPENAPI_YAML)
129+
@Override
128130
public String openapiYaml(HttpServletRequest request, @Value(DEFAULT_API_DOCS_URL_YAML) String apiDocsUrl)
129131
throws JsonProcessingException {
130132
return super.openapiYaml(request, apiDocsUrl);

‎springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/core/ActuatorWebMvcProvider.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@
3838

3939
import static org.apache.commons.lang3.StringUtils.EMPTY;
4040

41-
;
42-
43-
4441
/**
4542
* The type Web mvc actuator provider.
4643
* @author bnasslahsen

‎springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/core/MultipleOpenApiSupportConfiguration.java

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,10 @@
3333
import org.springdoc.core.RepositoryRestResourceProvider;
3434
import org.springdoc.core.SecurityOAuth2Provider;
3535
import org.springdoc.core.SpringDocConfigProperties;
36-
import org.springdoc.core.SpringdocActuatorBeanFactoryConfigurer;
3736
import org.springdoc.webmvc.api.MultipleOpenApiActuatorResource;
3837
import org.springdoc.webmvc.api.MultipleOpenApiWebMvcResource;
3938

4039
import org.springframework.beans.factory.ObjectFactory;
41-
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
4240
import org.springframework.boot.actuate.autoconfigure.web.server.ConditionalOnManagementPort;
4341
import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
4442
import org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;
@@ -53,7 +51,6 @@
5351
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
5452

5553
import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
56-
import static org.springdoc.core.Constants.SPRINGDOC_SHOW_ACTUATOR;
5754
import static org.springdoc.core.Constants.SPRINGDOC_USE_MANAGEMENT_PORT;
5855

5956

@@ -114,20 +111,6 @@ MultipleOpenApiWebMvcResource multipleOpenApiResource(List<GroupedOpenApi> group
114111
@ConditionalOnManagementPort(ManagementPortType.DIFFERENT)
115112
static class SpringDocWebMvcActuatorDifferentConfiguration {
116113

117-
/**
118-
* Springdoc bean factory post processor 3 bean factory post processor.
119-
*
120-
* @param groupedOpenApis the grouped open apis
121-
* @return the bean factory post processor
122-
*/
123-
@Bean
124-
@ConditionalOnProperty(SPRINGDOC_SHOW_ACTUATOR)
125-
@Lazy(false)
126-
static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor3(List<GroupedOpenApi> groupedOpenApis) {
127-
return new SpringdocActuatorBeanFactoryConfigurer(groupedOpenApis);
128-
}
129-
130-
131114
/**
132115
* Multiple open api actuator resource multiple open api actuator resource.
133116
*

0 commit comments

Comments
 (0)