Add support for spring.data.web properties.

Author: bnasslahsen

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

@@ -46,6 +46,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
@@ -88,8 +89,8 @@ public class SpringDocDataRestConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer() {
-		return new DataRestDelegatingMethodParameterCustomizer();
+	DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties) {
+		return new DataRestDelegatingMethodParameterCustomizer(optionalSpringDataWebProperties);
 	}
 
 	/**

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

@@ -2,6 +2,7 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Field;
+import java.util.Optional;
 
 import io.swagger.v3.oas.annotations.ExternalDocumentation;
 import io.swagger.v3.oas.annotations.Parameter;
@@ -22,6 +23,7 @@
 import org.springdoc.core.converters.models.Pageable;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 
+import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties;
 import org.springframework.core.MethodParameter;
 import org.springframework.data.web.PageableDefault;
 
@@ -35,11 +37,16 @@ public class DataRestDelegatingMethodParameterCustomizer implements DelegatingMe
 	 */
 	private static final Logger LOGGER = LoggerFactory.getLogger(DataRestDelegatingMethodParameterCustomizer.class);
 
+	private final Optional<SpringDataWebProperties> optionalSpringDataWebProperties;
+
+	public DataRestDelegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties) {
+		this.optionalSpringDataWebProperties = optionalSpringDataWebProperties;
+	}
 
 	@Override
 	public void customize(MethodParameter originalParameter, MethodParameter methodParameter) {
 		PageableDefault pageableDefault = originalParameter.getParameterAnnotation(PageableDefault.class);
-		if (pageableDefault != null) {
+		if (pageableDefault != null || optionalSpringDataWebProperties.isPresent()) {
 			Field field = FieldUtils.getDeclaredField(DelegatingMethodParameter.class, "additionalParameterAnnotations", true);
 			try {
 				Annotation[] parameterAnnotations = (Annotation[]) field.get(methodParameter);
@@ -62,8 +69,7 @@ public void customize(MethodParameter originalParameter, MethodParameter methodP
 	 * @param pageableDefault the pageable default
 	 * @return the new parameter annotation for field
 	 */
-	private static Annotation getNewParameterAnnotationForField(String parameterName, PageableDefault pageableDefault) {
-		String defaultValue = getDefaultValue(parameterName, pageableDefault);
+	private Annotation getNewParameterAnnotationForField(String parameterName, PageableDefault pageableDefault) {
 		Field field;
 		Parameter parameterNew = null;
 		try {
@@ -77,10 +83,7 @@ public Class<? extends Annotation> annotationType() {
 
 				@Override
 				public String name() {
-					if (parameterName.equals("sort"))
-						return defaultValue;
-					else
-						return parameter.name();
+					return getName(parameterName, pageableDefault, parameter.name());
 				}
 
 				@Override
@@ -289,10 +292,7 @@ public String[] allowableValues() {
 
 						@Override
 						public String defaultValue() {
-							if (!parameterName.equals("sort"))
-								return defaultValue;
-							else
-								return parameter.schema().defaultValue();
+							return getDefaultValue(parameterName, pageableDefault, parameter.schema().defaultValue());
 						}
 
 						@Override
@@ -369,27 +369,65 @@ public String ref() {
 		return parameterNew;
 	}
 
+	private String getName(String parameterName, PageableDefault pageableDefault, String originalName) {
+		String name = null;
+		switch (parameterName) {
+			case "size":
+				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 (optionalSpringDataWebProperties.isPresent())
+					name = optionalSpringDataWebProperties.get().getSort().getSortParameter();
+				break;
+			case "page":
+				if (optionalSpringDataWebProperties.isPresent())
+					name = optionalSpringDataWebProperties.get().getPageable().getPageParameter();
+				else
+					name = originalName;
+				break;
+			case "direction":
+					name = originalName;
+				break;
+			default:
+				// Do nothing here
+				break;
+		}
+		return name;
+	}
+
 	/**
 	 * Gets default value.
 	 *
 	 * @param parameterName the parameter name
 	 * @param pageableDefault the pageable default
+	 * @param defaultSchemaVal the default schema val
 	 * @return the default value
 	 */
-	private static String getDefaultValue(String parameterName, PageableDefault pageableDefault) {
+	private String getDefaultValue(String parameterName, PageableDefault pageableDefault, String defaultSchemaVal) {
 		String defaultValue = null;
 		switch (parameterName) {
 			case "size":
-				defaultValue = String.valueOf(pageableDefault.size());
+				if (pageableDefault != null)
+					defaultValue = String.valueOf(pageableDefault.size());
+				else if (optionalSpringDataWebProperties.isPresent())
+					defaultValue = String.valueOf(optionalSpringDataWebProperties.get().getPageable().getDefaultPageSize());
 				break;
 			case "sort":
-				defaultValue = String.join(",", pageableDefault.sort());
+				if (pageableDefault != null)
+					defaultValue = defaultSchemaVal;
 				break;
 			case "page":
-				defaultValue = String.valueOf(pageableDefault.page());
+				if (pageableDefault != null)
+					defaultValue = String.valueOf(pageableDefault.page());
 				break;
 			case "direction":
-				defaultValue = pageableDefault.direction().name();
+				if (pageableDefault != null)
+					defaultValue = pageableDefault.direction().name();
 				break;
 			default:
 				// Do nothing here

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app14/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.app14;
+
+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/app14/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.app14;
+
+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/app14/SpringDocApp14Test.java

@@ -0,0 +1,43 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * 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.app14;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.test.context.TestPropertySource;
+
+@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})
+public class SpringDocApp14Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}