Improve Pageable support

bnasslahsen · bnasslahsen · commit b292ef43f3c1 · 2020-04-26T01:28:12.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/api/annotations/ParameterObject.java b/springdoc-openapi-common/src/main/java/org/springdoc/api/annotations/ParameterObject.java
@@ -5,6 +5,6 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-@Target(ElementType.PARAMETER)
+@Target({ElementType.PARAMETER, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface ParameterObject {}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/DelegatingMethodParameter.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/DelegatingMethodParameter.java
@@ -35,6 +35,7 @@
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ParameterNameDiscoverer;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.lang.NonNull;
 
 /**
@@ -59,8 +60,8 @@ public static MethodParameter[] customize(String[] pNames, MethodParameter[] par
 		List<MethodParameter> explodedParameters = new ArrayList<>();
 		for (int i = 0; i < parameters.length; ++i) {
 			MethodParameter p = parameters[i];
-			if (p.hasParameterAnnotation(ParameterObject.class)) {
-				Class<?> paramClass = AdditionalModelsConverter.getReplacement(p.getParameterType());
+			Class<?> paramClass = AdditionalModelsConverter.getReplacement(p.getParameterType());
+			if (p.hasParameterAnnotation(ParameterObject.class) || AnnotatedElementUtils.isAnnotated(paramClass, ParameterObject.class)) {
 				MethodParameterPojoExtractor.extractFrom(paramClass).forEach(explodedParameters::add);
 			}
 			else {
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
@@ -148,7 +148,7 @@ SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils) {
 	}
 
 	@Bean
-	@ConditionalOnMissingBean
+	@Lazy(false)
 	ReturnTypeParser genericReturnTypeParser() {
 		return new ReturnTypeParser() {};
 	}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocUtils.java
@@ -130,5 +130,11 @@ public SpringDocUtils addSimpleTypePredicateForParameterObject(Predicate<Class<?
 		MethodParameterPojoExtractor.addSimpleTypePredicate(predicate);
 		return this;
 	}
+
+	public SpringDocUtils disableReplacement(Class source) {
+		AdditionalModelsConverter.disableReplacement(source);
+		return this;
+	}
+
 }
 
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
@@ -47,6 +47,11 @@ public static Class getReplacement(Class clazz) {
 		return modelToClassMap.getOrDefault(clazz, clazz);
 	}
 
+	public static void disableReplacement(Class clazz) {
+		if(modelToClassMap.containsKey(clazz))
+			modelToClassMap.remove(clazz);
+	}
+
 	@Override
 	public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
 		JavaType javaType = Json.mapper().constructType(type.getType());
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/Pageable.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/Pageable.java
@@ -22,13 +22,13 @@
 import java.util.Objects;
 
 import javax.validation.constraints.Min;
-import javax.validation.constraints.NotNull;
 
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Schema;
+import org.springdoc.api.annotations.ParameterObject;
 
-@NotNull
+@ParameterObject
 public class Pageable {
 
 	@Min(0)
diff --git a/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java b/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -32,6 +32,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.Constants;
+import org.springdoc.data.rest.converters.Pageable;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
@@ -42,6 +43,7 @@
 
 import static org.hamcrest.Matchers.is;
 import static org.skyscreamer.jsonassert.JSONAssert.assertEquals;
+import static org.springdoc.core.SpringDocUtils.getConfig;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -75,6 +77,7 @@ public static String getContent(String fileName) throws Exception {
 	public static void afterClass() {
 		modelConverters.forEach(ModelConverters.getInstance()::removeConverter);
 		System.clearProperty("spring.hateoas.use-hal-as-default-json-media-type");
+		getConfig().replaceWithClass(org.springframework.data.domain.Pageable.class, Pageable.class);
 	}
 
 	@Autowired
diff --git a/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/SpringDocApp2Test.java b/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/SpringDocApp2Test.java
@@ -18,13 +18,22 @@
 
 package test.org.springdoc.api.app2;
 
+import javax.annotation.PostConstruct;
+
 import test.org.springdoc.api.AbstractSpringDocTest;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
+import static org.springdoc.core.SpringDocUtils.getConfig;
+
 public class SpringDocApp2Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication
 	static class SpringDocTestApp {}
 
+	@PostConstruct
+	public void init (){
+		getConfig().disableReplacement(org.springframework.data.domain.Pageable.class);
+	}
+
 }
diff --git a/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app7/HelloController.java b/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app7/HelloController.java
@@ -22,8 +22,6 @@
 
 import javax.validation.constraints.NotNull;
 
-import org.springdoc.api.annotations.ParameterObject;
-
 import org.springframework.data.domain.Pageable;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -33,7 +31,7 @@
 public class HelloController {
 
 	@GetMapping(value = "/search", produces = { "application/xml", "application/json" })
-	public ResponseEntity<List<PersonDTO>> getAllPets(@NotNull @ParameterObject Pageable pageable) {
+	public ResponseEntity<List<PersonDTO>> getAllPets(@NotNull Pageable pageable) {
 		return null;
 	}
 
diff --git a/springdoc-openapi-data-rest/src/test/resources/results/app2.json b/springdoc-openapi-data-rest/src/test/resources/results/app2.json
@@ -58,21 +58,40 @@
       "Pageable": {
         "type": "object",
         "properties": {
-          "page": {
-            "minimum": 0,
+          "offset": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "sort": {
+            "$ref": "#/components/schemas/Sort"
+          },
+          "pageSize": {
             "type": "integer",
             "format": "int32"
           },
-          "size": {
-            "minimum": 1,
+          "unpaged": {
+            "type": "boolean"
+          },
+          "paged": {
+            "type": "boolean"
+          },
+          "pageNumber": {
             "type": "integer",
             "format": "int32"
+          }
+        }
+      },
+      "Sort": {
+        "type": "object",
+        "properties": {
+          "sorted": {
+            "type": "boolean"
           },
-          "sort": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            }
+          "unsorted": {
+            "type": "boolean"
+          },
+          "empty": {
+            "type": "boolean"
           }
         }
       },
diff --git a/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java b/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java
@@ -39,6 +39,7 @@
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import reactor.core.publisher.Mono;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.MediaType;
 import org.springframework.http.server.reactive.ServerHttpRequest;
@@ -54,6 +55,7 @@
 import static org.springdoc.core.Constants.API_DOCS_URL;
 import static org.springdoc.core.Constants.APPLICATION_OPENAPI_YAML;
 import static org.springdoc.core.Constants.DEFAULT_API_DOCS_URL_YAML;
+import static org.springdoc.core.Constants.DEFAULT_GROUP_NAME;
 import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
 
 @RestController
@@ -69,6 +71,15 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
 	}
 
+	@Autowired
+	public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
+			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
+			Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties) {
+		super(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder, responseBuilder, operationParser, openApiCustomisers, springDocConfigProperties);
+		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
+	}
+
 	@Operation(hidden = true)
 	@GetMapping(value = API_DOCS_URL, produces = MediaType.APPLICATION_JSON_VALUE)
 	public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_DOCS_URL) String apiDocsUrl)
diff --git a/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/core/SpringDocWebFluxConfiguration.java b/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/core/SpringDocWebFluxConfiguration.java
@@ -45,7 +45,6 @@
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
 import org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping;
 
-import static org.springdoc.core.Constants.DEFAULT_GROUP_NAME;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 
 @Configuration
@@ -60,7 +59,7 @@ OpenApiResource openApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBu
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties) {
-		return new OpenApiResource(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder,
+		return new OpenApiResource(openAPIBuilder, requestBuilder,
 				responseBuilder, operationParser,
 				requestMappingHandlerMapping,
 				openApiCustomisers, springDocConfigProperties);
diff --git a/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java b/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java
@@ -42,6 +42,7 @@
 import org.springdoc.core.SpringDocConfigProperties;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.http.MediaType;
@@ -58,6 +59,7 @@
 import static org.springdoc.core.Constants.API_DOCS_URL;
 import static org.springdoc.core.Constants.APPLICATION_OPENAPI_YAML;
 import static org.springdoc.core.Constants.DEFAULT_API_DOCS_URL_YAML;
+import static org.springdoc.core.Constants.DEFAULT_GROUP_NAME;
 import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
 
 @RestController
@@ -82,6 +84,20 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
 	}
 
+	@Autowired
+	public OpenApiResource( OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
+			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
+			Optional<ActuatorProvider> servletContextProvider,
+			Optional<List<OpenApiCustomiser>> openApiCustomisers,
+			SpringDocConfigProperties springDocConfigProperties,
+			Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider) {
+		super(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder, responseBuilder, operationParser, openApiCustomisers, springDocConfigProperties);
+		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
+		this.servletContextProvider = servletContextProvider;
+		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
+	}
+
 	@Operation(hidden = true)
 	@GetMapping(value = API_DOCS_URL, produces = MediaType.APPLICATION_JSON_VALUE)
 	public String openapiJson(HttpServletRequest request, @Value(API_DOCS_URL) String apiDocsUrl)
diff --git a/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/core/SpringDocWebMvcConfiguration.java b/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/core/SpringDocWebMvcConfiguration.java
@@ -50,7 +50,6 @@
 import org.springframework.web.method.HandlerMethod;
 import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
 
-import static org.springdoc.core.Constants.DEFAULT_GROUP_NAME;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_SHOW_ACTUATOR;
 
@@ -69,7 +68,7 @@ OpenApiResource openApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBu
 			SpringDocConfigProperties springDocConfigProperties,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers,
 			Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider) {
-		return new OpenApiResource(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder,
+		return new OpenApiResource(openAPIBuilder, requestBuilder,
 				responseBuilder, operationParser,
 				requestMappingHandlerMapping, servletContextProvider,
 				openApiCustomisers, springDocConfigProperties, springSecurityOAuth2Provider);

Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils) {`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`@Bean`
`151`		`- @ConditionalOnMissingBean`
	`151`	`+ @Lazy(false)`
`152`	`152`	`ReturnTypeParser genericReturnTypeParser() {`
`153`	`153`	`return new ReturnTypeParser() {};`
`154`	`154`	`}`
Original file line number	Diff line number	Diff line change
`@@ -130,5 +130,11 @@ public SpringDocUtils addSimpleTypePredicateForParameterObject(Predicate<Class<?`
`130`	`130`	`MethodParameterPojoExtractor.addSimpleTypePredicate(predicate);`
`131`	`131`	`return this;`
`132`	`132`	`}`
	`133`	`+`
	`134`	`+ public SpringDocUtils disableReplacement(Class source) {`
	`135`	`+ AdditionalModelsConverter.disableReplacement(source);`
	`136`	`+ return this;`
	`137`	`+ }`
	`138`	`+`
`133`	`139`	`}`
`134`	`140`