Enhance Pageable config. Fixes #1373.

bnasslahsen · bnasslahsen · commit 2860eb1dec95 · 2021-12-11T18:35:29.000+01:00
diff --git a/springdoc-openapi-common/pom.xml b/springdoc-openapi-common/pom.xml
@@ -46,6 +46,12 @@
 			<artifactId>spring-boot-starter-actuator</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<!-- For Enhanced Pageable Support -->
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-commons</artifactId>
+			<optional>true</optional>
+		</dependency>
 	</dependencies>
 	<build>
 		<plugins>
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
@@ -167,6 +167,30 @@ public class SpringDocConfigProperties {
 	 */
 	private boolean disableI18n;
 
+	/**
+	 * The model Converters
+	 */
+	private ModelConverters modelConverters = new ModelConverters();
+
+	/**
+	 * Gets model converters.
+	 *
+	 * @return the model converters
+	 */
+	public ModelConverters getModelConverters() {
+		return modelConverters;
+	}
+
+	/**
+	 * Sets model converters.
+	 *
+	 * @param modelConverters the model converters
+	 */
+	public void setModelConverters(ModelConverters modelConverters) {
+		this.modelConverters = modelConverters;
+	}
+
+
 	/**
 	 * Is use management port boolean.
 	 *
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
@@ -70,6 +70,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
+import org.springframework.data.domain.Pageable;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.CollectionUtils;
@@ -176,19 +177,6 @@ SchemaPropertyDeprecatingConverter schemaPropertyDeprecatingConverter() {
 		return new SchemaPropertyDeprecatingConverter();
 	}
 
-	/**
-	 * Pageable open api converter pageable open api converter.
-	 *
-	 * @return the pageable open api converter
-	 */
-	@Bean
-	@ConditionalOnMissingBean
-	@ConditionalOnProperty(name = SPRINGDOC_PAGEABLE_CONVERTER_ENABLED)
-	@Lazy(false)
-	PageableOpenAPIConverter pageableOpenAPIConverter() {
-		return new PageableOpenAPIConverter();
-	}
-
 	/**
 	 * Polymorphic model converter polymorphic model converter.
 	 *
@@ -262,7 +250,7 @@ OperationService operationBuilder(GenericParameterService parameterBuilder, Requ
 	 */
 	@Bean
 	PropertyResolverUtils propertyResolverUtils(ConfigurableBeanFactory factory, MessageSource messageSource, SpringDocConfigProperties springDocConfigProperties) {
-		return new PropertyResolverUtils(factory, messageSource,springDocConfigProperties);
+		return new PropertyResolverUtils(factory, messageSource, springDocConfigProperties);
 	}
 
 	/**
@@ -450,4 +438,26 @@ WebConversionServiceProvider webConversionServiceProvider(Optional<WebConversion
 		}
 	}
 
+	/**
+	 * The type Spring doc pageable configuration.
+	 */
+	@ConditionalOnClass(Pageable.class)
+	static class SpringDocPageableConfiguration {
+
+		/**
+		 * Pageable open api converter pageable open api converter.
+		 *
+		 * @return the pageable open api converter
+		 */
+		@Bean
+		@ConditionalOnMissingBean
+		@ConditionalOnProperty(name = SPRINGDOC_PAGEABLE_CONVERTER_ENABLED, matchIfMissing = true)
+		@Lazy(false)
+		PageableOpenAPIConverter pageableOpenAPIConverter() {
+			getConfig().replaceParameterObjectWithClass(org.springframework.data.domain.Pageable.class, org.springdoc.core.converters.models.Pageable.class)
+					.replaceParameterObjectWithClass(org.springframework.data.domain.PageRequest.class, org.springdoc.core.converters.models.Pageable.class);
+			return new PageableOpenAPIConverter();
+		}
+	}
+
 }
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/SpringDocDataRestConfiguration.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/SpringDocDataRestConfiguration.java
@@ -34,9 +34,7 @@
 import org.springdoc.core.OperationService;
 import org.springdoc.core.RequestBodyService;
 import org.springdoc.core.SpringDocConfigProperties;
-import org.springdoc.core.converters.PageableOpenAPIConverter;
 import org.springdoc.core.converters.models.DefaultPageable;
-import org.springdoc.core.converters.models.Pageable;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 import org.springdoc.data.rest.core.DataRestOperationService;
 import org.springdoc.data.rest.core.DataRestRequestService;
@@ -73,7 +71,6 @@
 import org.springframework.hateoas.server.LinkRelationProvider;
 
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
-import static org.springdoc.core.Constants.SPRINGDOC_PAGEABLE_CONVERTER_ENABLED;
 import static org.springdoc.core.SpringDocUtils.getConfig;
 
 /**
@@ -85,24 +82,6 @@
 @ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
 public class SpringDocDataRestConfiguration {
 
-	static {
-		getConfig().replaceParameterObjectWithClass(org.springframework.data.domain.Pageable.class, Pageable.class)
-				.replaceParameterObjectWithClass(org.springframework.data.domain.PageRequest.class, Pageable.class);
-	}
-
-	/**
-	 * Pageable open api converter pageable open api converter.
-	 *
-	 * @return the pageable open api converter
-	 */
-	@Bean
-	@ConditionalOnMissingBean
-	@ConditionalOnProperty(name = SPRINGDOC_PAGEABLE_CONVERTER_ENABLED, matchIfMissing = true)
-	@Lazy(false)
-	PageableOpenAPIConverter pageableOpenAPIConverter() {
-		return new PageableOpenAPIConverter();
-	}
-
 	/**
 	 * Delegating method parameter customizer delegating method parameter customizer.
 	 *
diff --git a/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app14/SpringDocApp14Test.java b/springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app14/SpringDocApp14Test.java
@@ -25,7 +25,6 @@
 
 import java.util.Optional;
 
-import org.springdoc.core.converters.models.Pageable;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 import org.springdoc.data.rest.SpringDocDataRestConfiguration;
 import org.springdoc.data.rest.customisers.DataRestDelegatingMethodParameterCustomizer;
@@ -41,8 +40,6 @@
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.test.context.TestPropertySource;
 
-import static org.springdoc.core.SpringDocUtils.getConfig;
-
 @TestPropertySource(properties = { "spring.data.web.pageable.default-page-size=25",
 		"spring.data.web.pageable.page-parameter=pages",
 		"spring.data.web.pageable.size-parameter=sizes",
@@ -52,12 +49,6 @@
 })
 public class SpringDocApp14Test extends AbstractSpringDocTest {
 
-	static {
-		getConfig().replaceParameterObjectWithClass(org.springframework.data.domain.Pageable.class, Pageable.class)
-				.replaceParameterObjectWithClass(org.springframework.data.domain.PageRequest.class, Pageable.class);
-	}
-
-
 	@SpringBootApplication
 	static class SpringDocTestApp {
 		// We only need to test spring-web with Pageable, without the use of spring-data-rest-starter
diff --git a/springdoc-openapi-webmvc-core/pom.xml b/springdoc-openapi-webmvc-core/pom.xml
@@ -43,6 +43,12 @@
 			<artifactId>tomcat-embed-core</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<!-- For Enhanced Pageable Support -->
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-commons</artifactId>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 	<build>
 		<plugins>
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app125/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app125/HelloController.java
@@ -2,6 +2,9 @@
 
 import javax.validation.constraints.NotNull;
 
+import org.springdoc.api.annotations.ParameterObject;
+
+import org.springframework.data.domain.Pageable;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -16,4 +19,7 @@ public DeprecatedEntity getAllPets(@NotNull String toto) {
 		return null;
 	}
 
+	@GetMapping(value = "/search2", produces = { "application/xml", "application/json" })
+	public void getAllPets2(@ParameterObject Pageable pageable) {
+	}
 }
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app125.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app125.json
@@ -45,6 +45,55 @@
           }
         }
       }
+    },
+    "/search2": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "getAllPets2",
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Zero-based page index (0..N)",
+            "required": false,
+            "schema": {
+              "minimum": 0,
+              "type": "integer",
+              "default": 0
+            }
+          },
+          {
+            "name": "size",
+            "in": "query",
+            "description": "The size of the page to be returned",
+            "required": false,
+            "schema": {
+              "minimum": 1,
+              "type": "integer",
+              "default": 20
+            }
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
     }
   },
   "components": {

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,9 @@`
`2`	`2`
`3`	`3`	`import javax.validation.constraints.NotNull;`
`4`	`4`
	`5`	`+import org.springdoc.api.annotations.ParameterObject;`
	`6`	`+`
	`7`	`+import org.springframework.data.domain.Pageable;`
`5`	`8`	`import org.springframework.web.bind.annotation.GetMapping;`
`6`	`9`	`import org.springframework.web.bind.annotation.RestController;`
`7`	`10`
`@@ -16,4 +19,7 @@ public DeprecatedEntity getAllPets(@NotNull String toto) {`
`16`	`19`	`return null;`
`17`	`20`	`}`
`18`	`21`
	`22`	`+ @GetMapping(value = "/search2", produces = { "application/xml", "application/json" })`
	`23`	`+ public void getAllPets2(@ParameterObject Pageable pageable) {`
	`24`	`+ }`
`19`	`25`	`}`