Add better support for locale when using "new OpenAPI()". Fixes #1360

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -87,6 +87,7 @@
 import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
 import org.springdoc.core.annotations.RouterOperations;
 import org.springdoc.core.customizers.OpenApiCustomiser;
+import org.springdoc.core.customizers.OpenApiLocaleCustomizer;
 import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.fn.AbstractRouterFunctionVisitor;
 import org.springdoc.core.fn.RouterFunctionData;
@@ -196,6 +197,11 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 */
 	private static Class<?> modelAndViewClass;
 
+	/**
+	 * The OpenApi with locale customizers.
+	 */
+	private final Map<String, OpenApiLocaleCustomizer> openApiLocaleCustomizers;
+
 	static {
 		try {
 			modelAndViewClass = Class.forName("org.springframework.web.servlet.ModelAndView");
@@ -243,6 +249,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
 		this.optionalActuatorProvider = actuatorProvider;
 		if (springDocConfigProperties.isPreLoadingEnabled())
 			Executors.newSingleThreadExecutor().execute(this::getOpenApi);
+		this.openApiLocaleCustomizers = openAPIService.getContext().getBeansOfType(OpenApiLocaleCustomizer.class);
 	}
 
 	/**
@@ -295,10 +302,10 @@ public static void addHiddenRestControllers(String... classes) {
 	 */
 	protected synchronized OpenAPI getOpenApi(Locale locale) {
 		OpenAPI openApi;
-		locale = locale == null ? Locale.getDefault() : locale;
-		if (openAPIService.getCachedOpenAPI(locale) == null || springDocConfigProperties.isCacheDisabled()) {
+		final Locale finalLocale = locale == null ? Locale.getDefault() : locale;
+		if (openAPIService.getCachedOpenAPI(finalLocale) == null || springDocConfigProperties.isCacheDisabled()) {
 			Instant start = Instant.now();
-			openAPIService.build(locale);
+			openAPIService.build(finalLocale);
 			Map<String, Object> mappingsMap = openAPIService.getMappingsMap().entrySet().stream()
 					.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
 							Hidden.class) == null))
@@ -311,9 +318,9 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 			if (springDocConfigProperties.isOverrideWithGenericResponse() && !CollectionUtils.isEmpty(findControllerAdvice)) {
 				if (!CollectionUtils.isEmpty(mappingsMap))
 					findControllerAdvice.putAll(mappingsMap);
-				responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice, locale);
+				responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice, finalLocale);
 			}
-			getPaths(mappingsMap, locale);
+			getPaths(mappingsMap, finalLocale);
 			if (!CollectionUtils.isEmpty(openApi.getServers()))
 				openAPIService.setServersPresent(true);
 			openAPIService.updateServers(openApi);
@@ -332,19 +339,20 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 				LOGGER.warn("Json Processing Exception occurred: {}", e.getMessage());
 			}
 
+			openApiLocaleCustomizers.values().forEach(openApiLocaleCustomizer -> openApiLocaleCustomizer.customise(openApi, finalLocale));
 			openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
 			if (!CollectionUtils.isEmpty(openApi.getServers()) && !openApi.getServers().equals(serversCopy))
 				openAPIService.setServersPresent(true);
 
-			openAPIService.setCachedOpenAPI(openApi, locale);
+			openAPIService.setCachedOpenAPI(openApi, finalLocale);
 			openAPIService.resetCalculatedOpenAPI();
 
 			LOGGER.info("Init duration for springdoc-openapi is: {} ms",
 					Duration.between(start, Instant.now()).toMillis());
 		}
 		else {
 			LOGGER.debug("Fetching openApi document from cache");
-			openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI(locale));
+			openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI(finalLocale));
 		}
 		return openApi;
 	}

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/OpenApiLocaleCustomizer.java

@@ -0,0 +1,42 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package org.springdoc.core.customizers;
+
+import java.util.Locale;
+
+import io.swagger.v3.oas.models.OpenAPI;
+
+/**
+ * The interface Open api locale customizer.
+ * @author bnasslahsen
+ */
+@FunctionalInterface
+public interface OpenApiLocaleCustomizer {
+
+	/**
+	 * Customise.
+	 *
+	 * @param openApi the open api
+	 * @param locale the locale
+	 */
+	void customise(OpenAPI openApi, Locale locale);
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app171/SpringDocApp171Test.java

@@ -22,9 +22,13 @@
 
 import org.junit.jupiter.api.Test;
 import org.springdoc.core.Constants;
+import org.springdoc.core.customizers.OpenApiLocaleCustomizer;
 import test.org.springdoc.api.AbstractSpringDocTest;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.support.ResourceBundleMessageSource;
 import org.springframework.http.HttpHeaders;
 import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MvcResult;
@@ -40,6 +44,16 @@ public class SpringDocApp171Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication
 	static class SpringDocTestApp {
+
+		@Autowired
+		ResourceBundleMessageSource resourceBundleMessageSource;
+
+		@Bean
+		public OpenApiLocaleCustomizer openApiLocaleCustomizer() {
+			return (openAPI, locale)
+					-> openAPI.getInfo().title(resourceBundleMessageSource.getMessage("test", null, locale));
+		}
+
 	}
 
 	@Test

springdoc-openapi-webmvc-core/src/test/resources/results/app171-en-GB.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.1",
   "info": {
-    "title": "OpenAPI definition",
+    "title": "This is a test message[EN_GB]",
     "version": "v0"
   },
   "servers": [

springdoc-openapi-webmvc-core/src/test/resources/results/app171-en-US.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.1",
   "info": {
-    "title": "OpenAPI definition",
+    "title": "This is a test message",
     "version": "v0"
   },
   "servers": [

springdoc-openapi-webmvc-core/src/test/resources/results/app171-fr-FR.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.1",
   "info": {
-    "title": "OpenAPI definition",
+    "title": "This is a test message[FR]",
     "version": "v0"
   },
   "servers": [