Allow ModelAndView to be detected. Fixes #428.

bnasslahsen · bnasslahsen · commit 88327e6329ff · 2020-02-16T15:26:33.000+01:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java b/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java
@@ -81,7 +81,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 
 	private final AntPathMatcher antPathMatcher = new AntPathMatcher();
 
-	private final SpringDocConfigProperties springDocConfigProperties;
+	protected final SpringDocConfigProperties springDocConfigProperties;
 
 	private static final List<Class<?>> ADDITIONAL_REST_CONTROLLERS = new ArrayList<>();
 	private static final List<Class<?>> HIDDEN_REST_CONTROLLERS = new ArrayList<>();
@@ -110,7 +110,7 @@ protected AbstractOpenApiResource(String groupName, OpenAPIBuilder openAPIBuilde
 
 	protected synchronized OpenAPI getOpenApi() {
 		OpenAPI openApi;
-		if (!computeDone || Boolean.TRUE.equals(springDocConfigProperties.getCache().getDisabled())) {
+		if (!computeDone || springDocConfigProperties.getCache().isDisabled()) {
 			Instant start = Instant.now();
 			openAPIBuilder.build();
 			Map<String, Object> restControllersMap = openAPIBuilder.getRestControllersMap();
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java
@@ -213,7 +213,7 @@ public Operation buildTags(HandlerMethod handlerMethod, Operation operation, Ope
 			operation.setTags(new ArrayList<>(tagsStr));
 		}
 
-		if (CollectionUtils.isEmpty(operation.getTags()) && Boolean.TRUE.equals(springDocConfigProperties.getAutoTagClasses())) {
+		if (CollectionUtils.isEmpty(operation.getTags()) && springDocConfigProperties.isAutoTagClasses()) {
 			operation.addTagsItem(splitCamelCase(handlerMethod.getBeanType().getSimpleName()));
 		}
 
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java
@@ -32,7 +32,7 @@
 @ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
 public class SpringDocConfigProperties {
 
-	private Boolean showActuator = false;
+	private boolean showActuator;
 
 	private Webjars webjars = new Webjars();
 
@@ -50,16 +50,26 @@ public class SpringDocConfigProperties {
 
 	private List<GroupConfig> groupConfigs = new ArrayList<>();
 
-	private Boolean autoTagClasses = true;
+	private boolean autoTagClasses = true;
 
-	public Boolean getAutoTagClasses() {
+	private boolean modelAndViewAllowed;
+
+	public boolean isAutoTagClasses() {
 		return autoTagClasses;
 	}
 
-	public void setAutoTagClasses(Boolean autoTagClasses) {
+	public void setAutoTagClasses(boolean autoTagClasses) {
 		this.autoTagClasses = autoTagClasses;
 	}
 
+	public boolean isModelAndViewAllowed() {
+		return modelAndViewAllowed;
+	}
+
+	public void setModelAndViewAllowed(boolean modelAndViewAllowed) {
+		this.modelAndViewAllowed = modelAndViewAllowed;
+	}
+
 	public List<String> getPackagesToExclude() {
 		return packagesToExclude;
 	}
@@ -84,11 +94,11 @@ public void setPackagesToScan(List<String> packagesToScan) {
 		this.packagesToScan = packagesToScan;
 	}
 
-	public Boolean getShowActuator() {
+	public boolean isShowActuator() {
 		return showActuator;
 	}
 
-	public void setShowActuator(Boolean showActuator) {
+	public void setShowActuator(boolean showActuator) {
 		this.showActuator = showActuator;
 	}
 
@@ -145,7 +155,7 @@ public static class ApiDocs {
 		/**
 		 * Weather to generate and serve a OpenAPI document.
 		 */
-		private Boolean enabled = true;
+		private boolean enabled = true;
 
 		private Groups groups = new Groups();
 
@@ -157,11 +167,11 @@ public void setPath(String path) {
 			this.path = path;
 		}
 
-		public Boolean getEnabled() {
+		public boolean isEnabled() {
 			return enabled;
 		}
 
-		public void setEnabled(Boolean enabled) {
+		public void setEnabled(boolean enabled) {
 			this.enabled = enabled;
 		}
 
@@ -175,25 +185,25 @@ public void setGroups(Groups groups) {
 	}
 
 	public static class Groups {
-		private Boolean enabled = false;
+		private boolean enabled;
 
-		public Boolean getEnabled() {
+		public boolean isEnabled() {
 			return enabled;
 		}
 
-		public void setEnabled(Boolean enabled) {
+		public void setEnabled(boolean enabled) {
 			this.enabled = enabled;
 		}
 	}
 
 	public static class Cache {
-		private Boolean disabled = false;
+		private boolean disabled;
 
-		public Boolean getDisabled() {
+		public boolean isDisabled() {
 			return disabled;
 		}
 
-		public void setDisabled(Boolean disabled) {
+		public void setDisabled(boolean disabled) {
 			this.disabled = disabled;
 		}
 	}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java
@@ -22,10 +22,12 @@
 import java.util.List;
 import java.util.Optional;
 
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.media.ObjectSchema;
+import org.springdoc.core.converters.AdditionalModelsConverter;
 import org.springdoc.core.converters.ModelConverterRegistrar;
-import org.springdoc.core.converters.ObjectNodeConverter;
 import org.springdoc.core.converters.PropertyCustomizingConverter;
 import org.springdoc.core.converters.ResponseSupportConverter;
 import org.springdoc.core.customizers.PropertyCustomizer;
@@ -49,14 +51,17 @@
 @ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
 public class SpringDocConfiguration {
 
+	static {
+		AdditionalModelsConverter.replaceWithSchema(ObjectNode.class, new ObjectSchema());
+	}
 	@Bean
 	LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer() {
 		return new LocalVariableTableParameterNameDiscoverer();
 	}
 
 	@Bean
-	ObjectNodeConverter objectNodeConverter() {
-		return new ObjectNodeConverter();
+	AdditionalModelsConverter pageableSupportConverter() {
+		return new AdditionalModelsConverter();
 	}
 
 	@Bean
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/AdditionalModelsConverter.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/AdditionalModelsConverter.java
@@ -18,28 +18,31 @@
 
 package org.springdoc.core.converters;
 
+
+import java.util.HashMap;
 import java.util.Iterator;
+import java.util.Map;
 
 import com.fasterxml.jackson.databind.JavaType;
-import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.swagger.v3.core.converter.AnnotatedType;
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.core.converter.ModelConverterContext;
 import io.swagger.v3.core.util.Json;
-import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
 
-@SuppressWarnings("rawtypes")
-public class ObjectNodeConverter implements ModelConverter {
+public class AdditionalModelsConverter implements ModelConverter {
 
+	private static Map<Class, Class> modelToClassMap= new HashMap();
+	private static Map<Class, Schema> modelToSchemaMap= new HashMap();
 	@Override
 	public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
 		JavaType javaType = Json.mapper().constructType(type.getType());
 		if (javaType != null) {
 			Class<?> cls = javaType.getRawClass();
-			if (ObjectNode.class.isAssignableFrom(cls)) {
-				return new ObjectSchema();
-			}
+			if(modelToSchemaMap.containsKey(cls))
+				return modelToSchemaMap.get(cls);
+			if(modelToClassMap.containsKey(cls))
+				type = new AnnotatedType(modelToClassMap.get(cls));
 		}
 		if (chain.hasNext()) {
 			return chain.next().resolve(type, context, chain);
@@ -48,4 +51,13 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 			return null;
 		}
 	}
+
+	public static void replaceWithClass(Class source, Class target) {
+		modelToClassMap.put(source, target);
+	}
+
+	public static void replaceWithSchema(Class source, Schema target) {
+		modelToSchemaMap.put(source, target);
+	}
+
 }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/ConverterUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/ConverterUtils.java
@@ -48,7 +48,7 @@ public static void addResponseTypeToIgnore(Class<?> cls){
 		RESPONSE_TYPES_TO_IGNORE.add(cls);
 	}
 
-	public static boolean isResponseTypeWrapper(Class<?> rawClass) {
+	static boolean isResponseTypeWrapper(Class<?> rawClass) {
 		return RESULT_WRAPPERS_TO_IGNORE.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
 	}
 
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/core/SpringDocDataRestConfiguration.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/core/SpringDocDataRestConfiguration.java
@@ -28,7 +28,8 @@
 import io.swagger.v3.oas.models.media.MapSchema;
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.StringSchema;
-import org.springdoc.core.converters.PageableSupportConverter;
+import org.springdoc.core.converters.AdditionalModelsConverter;
+import org.springdoc.core.converters.Pageable;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -46,10 +47,10 @@
 @ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
 public class SpringDocDataRestConfiguration {
 
-    @Bean
-    PageableSupportConverter pageableSupportConverter() {
-        return new PageableSupportConverter();
-    }
+	static {
+		AdditionalModelsConverter.replaceWithClass(org.springframework.data.domain.Pageable.class, Pageable.class);
+		AdditionalModelsConverter.replaceWithClass(org.springframework.data.domain.PageRequest.class,Pageable.class);
+	}
 
     @Bean
     public HalProvider halProvider(RepositoryRestConfiguration repositoryRestConfiguration) {
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/core/converters/PageableSupportConverter.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/core/converters/PageableSupportConverter.java
diff --git a/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/api/OpenApiResource.java b/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/api/OpenApiResource.java
@@ -145,7 +145,7 @@ private boolean isRestController(Map<String, Object> restControllers, HandlerMet
 
 		return (responseBodyAnnotation != null && restControllers.containsKey(handlerMethod.getBean().toString()) || isAdditionalRestController(handlerMethod.getBeanType()))
 				&& operationPath.startsWith(DEFAULT_PATH_SEPARATOR)
-				&& !ModelAndView.class.isAssignableFrom(handlerMethod.getMethod().getReturnType());
+				&& (springDocConfigProperties.isModelAndViewAllowed()|| !ModelAndView.class.isAssignableFrom(handlerMethod.getMethod().getReturnType()));
 	}
 
 	private void calculateServerUrl(HttpServletRequest request, String apiDocsUrl) {
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app89/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app89/HelloController.java
@@ -0,0 +1,37 @@
+/*
+ *
+ *  * 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 test.org.springdoc.api.app89;
+
+import io.swagger.v3.oas.annotations.Operation;
+
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.servlet.ModelAndView;
+
+@RestController
+public class HelloController {
+
+	@Operation(summary = "Get Status")
+	@GetMapping(value = "/status", produces = MediaType.TEXT_HTML_VALUE)
+	public ModelAndView getAddress(@PathVariable String id) {
+		return null;
+	}
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app89/SpringDocApp89Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app89/SpringDocApp89Test.java
@@ -0,0 +1,40 @@
+/*
+ *
+ *  * 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 test.org.springdoc.api.app89;
+
+
+import io.swagger.v3.oas.models.media.ObjectSchema;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.web.servlet.ModelAndView;
+
+import static org.springdoc.core.converters.AdditionalModelsConverter.replaceWithSchema;
+
+@TestPropertySource(properties = "springdoc.model-and-view-allowed=true")
+public class SpringDocApp89Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+	static {
+		replaceWithSchema(ModelAndView .class, new ObjectSchema());
+	}
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app89.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app89.json

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ public Operation buildTags(HandlerMethod handlerMethod, Operation operation, Ope`
`213`	`213`	`operation.setTags(new ArrayList<>(tagsStr));`
`214`	`214`	`}`
`215`	`215`
`216`		`- if (CollectionUtils.isEmpty(operation.getTags()) && Boolean.TRUE.equals(springDocConfigProperties.getAutoTagClasses())) {`
	`216`	`+ if (CollectionUtils.isEmpty(operation.getTags()) && springDocConfigProperties.isAutoTagClasses()) {`
`217`	`217`	`operation.addTagsItem(splitCamelCase(handlerMethod.getBeanType().getSimpleName()));`
`218`	`218`	`}`
`219`	`219`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`@ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)`
`33`	`33`	`public class SpringDocConfigProperties {`
`34`	`34`
`35`		`- private Boolean showActuator = false;`
	`35`	`+ private boolean showActuator;`
`36`	`36`
`37`	`37`	`private Webjars webjars = new Webjars();`
`38`	`38`
`@@ -50,16 +50,26 @@ public class SpringDocConfigProperties {`
`50`	`50`
`51`	`51`	`private List<GroupConfig> groupConfigs = new ArrayList<>();`
`52`	`52`
`53`		`- private Boolean autoTagClasses = true;`
	`53`	`+ private boolean autoTagClasses = true;`
`54`	`54`
`55`		`- public Boolean getAutoTagClasses() {`
	`55`	`+ private boolean modelAndViewAllowed;`
	`56`	`+`
	`57`	`+ public boolean isAutoTagClasses() {`
`56`	`58`	`return autoTagClasses;`
`57`	`59`	`}`
`58`	`60`
`59`		`- public void setAutoTagClasses(Boolean autoTagClasses) {`
	`61`	`+ public void setAutoTagClasses(boolean autoTagClasses) {`
`60`	`62`	`this.autoTagClasses = autoTagClasses;`
`61`	`63`	`}`
`62`	`64`
	`65`	`+ public boolean isModelAndViewAllowed() {`
	`66`	`+ return modelAndViewAllowed;`
	`67`	`+ }`
	`68`	`+`
	`69`	`+ public void setModelAndViewAllowed(boolean modelAndViewAllowed) {`
	`70`	`+ this.modelAndViewAllowed = modelAndViewAllowed;`
	`71`	`+ }`
	`72`	`+`
`63`	`73`	`public List<String> getPackagesToExclude() {`
`64`	`74`	`return packagesToExclude;`
`65`	`75`	`}`
`@@ -84,11 +94,11 @@ public void setPackagesToScan(List<String> packagesToScan) {`
`84`	`94`	`this.packagesToScan = packagesToScan;`
`85`	`95`	`}`
`86`	`96`
`87`		`- public Boolean getShowActuator() {`
	`97`	`+ public boolean isShowActuator() {`
`88`	`98`	`return showActuator;`
`89`	`99`	`}`
`90`	`100`
`91`		`- public void setShowActuator(Boolean showActuator) {`
	`101`	`+ public void setShowActuator(boolean showActuator) {`
`92`	`102`	`this.showActuator = showActuator;`
`93`	`103`	`}`
`94`	`104`
`@@ -145,7 +155,7 @@ public static class ApiDocs {`
`145`	`155`	`/**`
`146`	`156`	`* Weather to generate and serve a OpenAPI document.`
`147`	`157`	`*/`
`148`		`- private Boolean enabled = true;`
	`158`	`+ private boolean enabled = true;`
`149`	`159`
`150`	`160`	`private Groups groups = new Groups();`
`151`	`161`
`@@ -157,11 +167,11 @@ public void setPath(String path) {`
`157`	`167`	`this.path = path;`
`158`	`168`	`}`
`159`	`169`
`160`		`- public Boolean getEnabled() {`
	`170`	`+ public boolean isEnabled() {`
`161`	`171`	`return enabled;`
`162`	`172`	`}`
`163`	`173`
`164`		`- public void setEnabled(Boolean enabled) {`
	`174`	`+ public void setEnabled(boolean enabled) {`
`165`	`175`	`this.enabled = enabled;`
`166`	`176`	`}`
`167`	`177`
`@@ -175,25 +185,25 @@ public void setGroups(Groups groups) {`
`175`	`185`	`}`
`176`	`186`
`177`	`187`	`public static class Groups {`
`178`		`- private Boolean enabled = false;`
	`188`	`+ private boolean enabled;`
`179`	`189`
`180`		`- public Boolean getEnabled() {`
	`190`	`+ public boolean isEnabled() {`
`181`	`191`	`return enabled;`
`182`	`192`	`}`
`183`	`193`
`184`		`- public void setEnabled(Boolean enabled) {`
	`194`	`+ public void setEnabled(boolean enabled) {`
`185`	`195`	`this.enabled = enabled;`
`186`	`196`	`}`
`187`	`197`	`}`
`188`	`198`
`189`	`199`	`public static class Cache {`
`190`		`- private Boolean disabled = false;`
	`200`	`+ private boolean disabled;`
`191`	`201`
`192`		`- public Boolean getDisabled() {`
	`202`	`+ public boolean isDisabled() {`
`193`	`203`	`return disabled;`
`194`	`204`	`}`
`195`	`205`
`196`		`- public void setDisabled(Boolean disabled) {`
	`206`	`+ public void setDisabled(boolean disabled) {`
`197`	`207`	`this.disabled = disabled;`
`198`	`208`	`}`
`199`	`209`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public static void addResponseTypeToIgnore(Class<?> cls){`
`48`	`48`	`RESPONSE_TYPES_TO_IGNORE.add(cls);`
`49`	`49`	`}`
`50`	`50`
`51`		`- public static boolean isResponseTypeWrapper(Class<?> rawClass) {`
	`51`	`+ static boolean isResponseTypeWrapper(Class<?> rawClass) {`
`52`	`52`	`return RESULT_WRAPPERS_TO_IGNORE.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ private boolean isRestController(Map<String, Object> restControllers, HandlerMet`
`145`	`145`
`146`	`146`	`return (responseBodyAnnotation != null && restControllers.containsKey(handlerMethod.getBean().toString()) \|\| isAdditionalRestController(handlerMethod.getBeanType()))`
`147`	`147`	`&& operationPath.startsWith(DEFAULT_PATH_SEPARATOR)`
`148`		`- && !ModelAndView.class.isAssignableFrom(handlerMethod.getMethod().getReturnType());`
	`148`	`+ && (springDocConfigProperties.isModelAndViewAllowed()\|\| !ModelAndView.class.isAssignableFrom(handlerMethod.getMethod().getReturnType()));`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`private void calculateServerUrl(HttpServletRequest request, String apiDocsUrl) {`