Add support for spring.data.rest.default... properties.

Author: bnasslahsen

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/SpringDocDataRestConfiguration.java

@@ -84,13 +84,15 @@ public class SpringDocDataRestConfiguration {
 	/**
 	 * Delegating method parameter customizer delegating method parameter customizer.
 	 *
+	 * @param optionalSpringDataWebProperties the optional spring data web properties
+	 * @param optionalRepositoryRestConfiguration the optional repository rest configuration
 	 * @return the delegating method parameter customizer
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties) {
-		return new DataRestDelegatingMethodParameterCustomizer(optionalSpringDataWebProperties);
+	DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties, Optional<RepositoryRestConfiguration> optionalRepositoryRestConfiguration) {
+		return new DataRestDelegatingMethodParameterCustomizer(optionalSpringDataWebProperties,optionalRepositoryRestConfiguration);
 	}
 
 	/**

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/customisers/DataRestDelegatingMethodParameterCustomizer.java

@@ -25,6 +25,7 @@
 
 import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties;
 import org.springframework.core.MethodParameter;
+import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.data.web.PageableDefault;
 
 /**
@@ -37,16 +38,31 @@ public class DataRestDelegatingMethodParameterCustomizer implements DelegatingMe
 	 */
 	private static final Logger LOGGER = LoggerFactory.getLogger(DataRestDelegatingMethodParameterCustomizer.class);
 
+	/**
+	 * The Optional spring data web properties.
+	 */
 	private final Optional<SpringDataWebProperties> optionalSpringDataWebProperties;
 
-	public DataRestDelegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties) {
+	/**
+	 * The Optional repository rest configuration.
+	 */
+	private final Optional<RepositoryRestConfiguration> optionalRepositoryRestConfiguration;
+
+	/**
+	 * Instantiates a new Data rest delegating method parameter customizer.
+	 *
+	 * @param optionalSpringDataWebProperties the optional spring data web properties
+	 * @param optionalRepositoryRestConfiguration the optional repository rest configuration
+	 */
+	public DataRestDelegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties, Optional<RepositoryRestConfiguration> optionalRepositoryRestConfiguration) {
 		this.optionalSpringDataWebProperties = optionalSpringDataWebProperties;
+		this.optionalRepositoryRestConfiguration = optionalRepositoryRestConfiguration;
 	}
 
 	@Override
 	public void customize(MethodParameter originalParameter, MethodParameter methodParameter) {
 		PageableDefault pageableDefault = originalParameter.getParameterAnnotation(PageableDefault.class);
-		if (pageableDefault != null || optionalSpringDataWebProperties.isPresent()) {
+		if (pageableDefault != null || optionalSpringDataWebProperties.isPresent() || optionalRepositoryRestConfiguration.isPresent()) {
 			Field field = FieldUtils.getDeclaredField(DelegatingMethodParameter.class, "additionalParameterAnnotations", true);
 			try {
 				Annotation[] parameterAnnotations = (Annotation[]) field.get(methodParameter);
@@ -369,29 +385,45 @@ public String ref() {
 		return parameterNew;
 	}
 
+	/**
+	 * Gets name.
+	 *
+	 * @param parameterName the parameter name
+	 * @param pageableDefault the pageable default
+	 * @param originalName the original name
+	 * @return the name
+	 */
 	private String getName(String parameterName, PageableDefault pageableDefault, String originalName) {
 		String name = null;
 		switch (parameterName) {
 			case "size":
-				if (optionalSpringDataWebProperties.isPresent())
+				if (optionalRepositoryRestConfiguration.isPresent())
+					name = optionalRepositoryRestConfiguration.get().getLimitParamName();
+				else if (optionalSpringDataWebProperties.isPresent())
 					name = optionalSpringDataWebProperties.get().getPageable().getSizeParameter();
 				else
 					name = originalName;
 				break;
 			case "sort":
 				if (pageableDefault != null && ArrayUtils.isNotEmpty(pageableDefault.sort()))
 					name = String.join(",", pageableDefault.sort());
+				else if (optionalRepositoryRestConfiguration.isPresent())
+					name = optionalRepositoryRestConfiguration.get().getSortParamName();
 				else if (optionalSpringDataWebProperties.isPresent())
 					name = optionalSpringDataWebProperties.get().getSort().getSortParameter();
+				else
+					name = originalName;
 				break;
 			case "page":
-				if (optionalSpringDataWebProperties.isPresent())
+				if (optionalRepositoryRestConfiguration.isPresent())
+					name = optionalRepositoryRestConfiguration.get().getPageParamName();
+				else if (optionalSpringDataWebProperties.isPresent())
 					name = optionalSpringDataWebProperties.get().getPageable().getPageParameter();
 				else
 					name = originalName;
 				break;
 			case "direction":
-					name = originalName;
+				name = originalName;
 				break;
 			default:
 				// Do nothing here
@@ -414,8 +446,12 @@ private String getDefaultValue(String parameterName, PageableDefault pageableDef
 			case "size":
 				if (pageableDefault != null)
 					defaultValue = String.valueOf(pageableDefault.size());
+				else if (optionalRepositoryRestConfiguration.isPresent())
+					defaultValue = String.valueOf(optionalRepositoryRestConfiguration.get().getDefaultPageSize());
 				else if (optionalSpringDataWebProperties.isPresent())
 					defaultValue = String.valueOf(optionalSpringDataWebProperties.get().getPageable().getDefaultPageSize());
+				else
+					defaultValue = defaultSchemaVal;
 				break;
 			case "sort":
 				if (pageableDefault != null)
@@ -424,10 +460,14 @@ else if (optionalSpringDataWebProperties.isPresent())
 			case "page":
 				if (pageableDefault != null)
 					defaultValue = String.valueOf(pageableDefault.page());
+				else
+					defaultValue = defaultSchemaVal;
 				break;
 			case "direction":
 				if (pageableDefault != null)
 					defaultValue = pageableDefault.direction().name();
+				else
+					defaultValue = defaultSchemaVal;
 				break;
 			default:
 				// Do nothing here

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app14/SpringDocApp14Test.java

@@ -23,21 +23,50 @@
 
 package test.org.springdoc.api.app14;
 
+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;
 import test.org.springdoc.api.AbstractSpringDocTest;
 
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration;
 import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Lazy;
+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",
 		"spring.data.web.sort.sort-parameter=sorts" })
-@EnableConfigurationProperties(value = { SpringDataWebProperties.class})
+@EnableAutoConfiguration(exclude = {
+		RepositoryRestMvcAutoConfiguration.class, SpringDocDataRestConfiguration.class
+})
 public class SpringDocApp14Test extends AbstractSpringDocTest {
 
+	static {
+		getConfig().replaceWithClass(org.springframework.data.domain.Pageable.class, Pageable.class)
+				.replaceWithClass(org.springframework.data.domain.PageRequest.class, Pageable.class);
+	}
+
+
 	@SpringBootApplication
-	static class SpringDocTestApp {}
+	static class SpringDocTestApp {
+		// We only need to test spring-web with Pageable, without the use of spring-data-rest-starter
+		@Bean
+		@ConditionalOnMissingBean
+		@Lazy(false)
+		DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties, Optional<RepositoryRestConfiguration> optionalRepositoryRestConfiguration) {
+			return new DataRestDelegatingMethodParameterCustomizer(optionalSpringDataWebProperties, optionalRepositoryRestConfiguration);
+		}
+	}
 
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app15/HelloController.java

@@ -0,0 +1,38 @@
+/*
+ *
+ *  * 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.app15;
+
+import java.util.List;
+
+import org.springdoc.api.annotations.ParameterObject;
+
+import org.springframework.data.domain.Pageable;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/search", produces = { "application/xml", "application/json" })
+	public ResponseEntity<List<PersonDTO>> getAllPets(@ParameterObject Pageable pageable) {
+		return null;
+	}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app15/PersonDTO.java

@@ -0,0 +1,63 @@
+/*
+ *
+ *  * 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.app15;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema
+public class PersonDTO {
+	private String email;
+
+	private String firstName;
+
+	private String lastName;
+
+	public PersonDTO() {
+	}
+
+	public PersonDTO(final String email, final String firstName, final String lastName) {
+		this.email = email;
+		this.firstName = firstName;
+		this.lastName = lastName;
+	}
+
+	public String getEmail() {
+		return email;
+	}
+
+	public void setEmail(final String email) {
+		this.email = email;
+	}
+
+	public String getFirstName() {
+		return firstName;
+	}
+
+	public void setFirstName(final String firstName) {
+		this.firstName = firstName;
+	}
+
+	public String getLastName() {
+		return lastName;
+	}
+
+	public void setLastName(final String lastName) {
+		this.lastName = lastName;
+	}
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app15/SpringDocApp15Test.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.app15;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+@TestPropertySource(properties = "spring.data.rest.default-page-size=50")
+public class SpringDocApp15Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-data-rest/src/test/resources/results/app14.json

@@ -25,7 +25,8 @@
             "required": false,
             "schema": {
               "minimum": 0,
-              "type": "integer"
+              "type": "integer",
+              "default": "0"
             }
           },
           {