Add support for @PageableDefault. Fixes #831.

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/ErrorMessage.java

@@ -25,8 +25,14 @@
  */
 public class ErrorMessage {
 
+	/**
+	 * The Id.
+	 */
 	private UUID id;
 
+	/**
+	 * The Message.
+	 */
 	private String message;
 
 	/**

springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java

@@ -231,7 +231,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 		String[] reflectionParametersNames = Arrays.stream(handlerMethod.getMethod().getParameters()).map(java.lang.reflect.Parameter::getName).toArray(String[]::new);
 		if (pNames == null || Arrays.stream(pNames).anyMatch(Objects::isNull))
 			pNames = reflectionParametersNames;
-		parameters = DelegatingMethodParameter.customize(pNames, parameters);
+		parameters = DelegatingMethodParameter.customize(pNames, parameters,parameterBuilder.getDelegatingMethodParameterCustomizer());
 		RequestBodyInfo requestBodyInfo = new RequestBodyInfo();
 		List<Parameter> operationParameters = (operation.getParameters() != null) ? operation.getParameters() : new ArrayList<>();
 		Map<String, io.swagger.v3.oas.annotations.Parameter> parametersDocMap = getApiParameters(handlerMethod.getMethod());

springdoc-openapi-common/src/main/java/org/springdoc/core/ActuatorProvider.java

@@ -63,6 +63,7 @@ default Tag getTag() {
 	 * Is rest controller boolean.
 	 *
 	 * @param operationPath the operation path
+	 * @param controllerClass the controller class
 	 * @return the boolean
 	 */
 	default boolean isRestController(String operationPath, Class<?>  controllerClass) {

springdoc-openapi-common/src/main/java/org/springdoc/core/DelegatingMethodParameter.java

@@ -30,10 +30,13 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
+import java.util.stream.Stream;
 
 import org.apache.commons.lang3.ArrayUtils;
 import org.springdoc.api.annotations.ParameterObject;
 import org.springdoc.core.converters.AdditionalModelsConverter;
+import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ParameterNameDiscoverer;
@@ -79,27 +82,37 @@ public class DelegatingMethodParameter extends MethodParameter {
 		this.delegate = delegate;
 		this.additionalParameterAnnotations = additionalParameterAnnotations;
 		this.parameterName = parameterName;
-		this.isParameterObject=isParameterObject;
+		this.isParameterObject = isParameterObject;
 	}
 
 	/**
 	 * Customize method parameter [ ].
 	 *
 	 * @param pNames the p names
 	 * @param parameters the parameters
+	 * @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
 	 * @return the method parameter [ ]
 	 */
-	public static MethodParameter[] customize(String[] pNames, MethodParameter[] parameters) {
+	public static MethodParameter[] customize(String[] pNames, MethodParameter[] parameters, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
 		List<MethodParameter> explodedParameters = new ArrayList<>();
 		for (int i = 0; i < parameters.length; ++i) {
 			MethodParameter p = parameters[i];
 			Class<?> paramClass = AdditionalModelsConverter.getReplacement(p.getParameterType());
 			if (p.hasParameterAnnotation(ParameterObject.class) || AnnotatedElementUtils.isAnnotated(paramClass, ParameterObject.class)) {
-				MethodParameterPojoExtractor.extractFrom(paramClass).forEach(explodedParameters::add);
+				Stream<MethodParameter> methodParameterStream = MethodParameterPojoExtractor.extractFrom(paramClass);
+				if (!optionalDelegatingMethodParameterCustomizer.isPresent())
+					MethodParameterPojoExtractor.extractFrom(paramClass).forEach(explodedParameters::add);
+				else {
+					DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer = optionalDelegatingMethodParameterCustomizer.get();
+					methodParameterStream.forEach(methodParameter -> {
+						delegatingMethodParameterCustomizer.customize(p, methodParameter);
+						explodedParameters.add(methodParameter);
+					});
+				}
 			}
 			else {
 				String name = pNames != null ? pNames[i] : p.getParameterName();
-				explodedParameters.add(new DelegatingMethodParameter(p, name, null,false));
+				explodedParameters.add(new DelegatingMethodParameter(p, name, null, false));
 			}
 		}
 		return explodedParameters.toArray(new MethodParameter[0]);

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java

@@ -47,6 +47,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ResolvableType;
@@ -65,6 +66,11 @@ public class GenericParameterBuilder {
 	 */
 	private static final List<Class<?>> FILE_TYPES = new ArrayList<>();
 
+	/**
+	 * The Optional delegating method parameter customizer.
+	 */
+	private final Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer;
+
 	/**
 	 * The constant LOGGER.
 	 */
@@ -84,9 +90,11 @@ public class GenericParameterBuilder {
 	 * Instantiates a new Generic parameter builder.
 	 *
 	 * @param propertyResolverUtils the property resolver utils
+	 * @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
 	 */
-	public GenericParameterBuilder(PropertyResolverUtils propertyResolverUtils) {
+	public GenericParameterBuilder(PropertyResolverUtils propertyResolverUtils,   Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
 		this.propertyResolverUtils = propertyResolverUtils;
+		this.optionalDelegatingMethodParameterCustomizer=optionalDelegatingMethodParameterCustomizer;
 	}
 
 	/**
@@ -413,6 +421,15 @@ public boolean isFile(MethodParameter methodParameter) {
 		}
 	}
 
+	/**
+	 * Gets delegating method parameter customizer.
+	 *
+	 * @return the delegating method parameter customizer
+	 */
+	public Optional<DelegatingMethodParameterCustomizer> getDelegatingMethodParameterCustomizer() {
+		return optionalDelegatingMethodParameterCustomizer;
+	}
+
 	/**
 	 * Is file boolean.
 	 *

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java

@@ -67,7 +67,6 @@
  * The type Generic response builder.
  * @author bnasslahsen
  */
-@SuppressWarnings("rawtypes")
 public class GenericResponseBuilder {
 
 	/**
@@ -539,6 +538,13 @@ private Map<String, ApiResponse> getGenericMapResponse(Class<?> beanType) {
 				.collect(LinkedHashMap::new, Map::putAll, Map::putAll);
 	}
 
+	/**
+	 * Is valid http code boolean.
+	 *
+	 * @param httpCode the http code
+	 * @param methodParameter the method parameter
+	 * @return the boolean
+	 */
 	private boolean isValidHttpCode(String httpCode, MethodParameter methodParameter) {
 		Set<io.swagger.v3.oas.annotations.responses.ApiResponse> responseSet = getApiResponses(methodParameter.getMethod());
 		if (isHttpCodePresent(httpCode, responseSet))
@@ -556,6 +562,13 @@ private boolean isValidHttpCode(String httpCode, MethodParameter methodParameter
 		return false;
 	}
 
+	/**
+	 * Is http code present boolean.
+	 *
+	 * @param httpCode the http code
+	 * @param responseSet the response set
+	 * @return the boolean
+	 */
 	private boolean isHttpCodePresent(String httpCode, Set<io.swagger.v3.oas.annotations.responses.ApiResponse> responseSet) {
 		return !responseSet.isEmpty() && responseSet.stream().anyMatch(apiResponseAnnotations -> httpCode.equals(apiResponseAnnotations.responseCode()));
 	}

springdoc-openapi-common/src/main/java/org/springdoc/core/ReturnTypeParser.java

@@ -73,6 +73,12 @@ else if (resolvedType.hasGenerics()) {
 		return genericType;
 	}
 
+	/**
+	 * Resolve type.
+	 *
+	 * @param resolvableTypes the resolvable types
+	 * @param contextClass the context class
+	 */
 	static void resolveType(ResolvableType[] resolvableTypes, Class<?> contextClass) {
 		for (int i = 0; i < resolvableTypes.length; i++) {
 			if (resolvableTypes[i].hasUnresolvableGenerics() && resolvableTypes[i].getType() instanceof ParameterizedType) {
@@ -88,6 +94,13 @@ else if (resolvableTypes[i].hasGenerics()) {
 		}
 	}
 
+	/**
+	 * Gets resolved type.
+	 *
+	 * @param resolvableType the resolvable type
+	 * @param contextClass the context class
+	 * @return the resolved type
+	 */
 	static ResolvableType getResolvedType(ResolvableType resolvableType, Class<?> contextClass) {
 		ParameterizedType parameterizedType = (ParameterizedType) resolvableType.getType();
 		Class<?>[] generics = new Class<?>[parameterizedType.getActualTypeArguments().length];

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

@@ -41,6 +41,7 @@
 import org.springdoc.core.converters.PropertyCustomizingConverter;
 import org.springdoc.core.converters.ResponseSupportConverter;
 import org.springdoc.core.converters.SchemaPropertyDeprecatingConverter;
+import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 import org.springdoc.core.customizers.OpenApiBuilderCustomiser;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.PropertyCustomizer;
@@ -271,12 +272,13 @@ ReturnTypeParser genericReturnTypeParser() {
 	 * Parameter builder generic parameter builder.
 	 *
 	 * @param propertyResolverUtils the property resolver utils
+	 * @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
 	 * @return the generic parameter builder
 	 */
 	@Bean
 	@ConditionalOnMissingBean
-	GenericParameterBuilder parameterBuilder(PropertyResolverUtils propertyResolverUtils) {
-		return new GenericParameterBuilder(propertyResolverUtils);
+	GenericParameterBuilder parameterBuilder(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
+		return new GenericParameterBuilder(propertyResolverUtils,optionalDelegatingMethodParameterCustomizer);
 	}
 
 	/**

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/ConverterUtils.java

@@ -84,7 +84,7 @@ public static void addResponseTypeToIgnore(Class<?> cls) {
 	/**
 	 * Is response type wrapper boolean.
 	 *
-	 * @param rawClass the raw class 
+	 * @param rawClass the raw class
 	 * @return the boolean
 	 */
 	public static boolean isResponseTypeWrapper(Class<?> rawClass) {
@@ -94,7 +94,7 @@ public static boolean isResponseTypeWrapper(Class<?> rawClass) {
 	/**
 	 * Is response type to ignore boolean.
 	 *
-	 * @param rawClass the raw class 
+	 * @param rawClass the raw class
 	 * @return the boolean
 	 */
 	public static boolean isResponseTypeToIgnore(Class<?> rawClass) {
@@ -126,7 +126,7 @@ public static void removeResponseTypeToIgnore(Class<?> classes) {
 	/**
 	 * Is flux type wrapper boolean.
 	 *
-	 * @param rawClass the raw class 
+	 * @param rawClass the raw class
 	 * @return the boolean
 	 */
 	public static boolean isFluxTypeWrapper(Class<?> rawClass) {

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/DefaultPageable.java

@@ -34,8 +34,8 @@ public class DefaultPageable extends Pageable {
 	/**
 	 * Instantiates a new Default pageable.
 	 *
-	 * @param page the page 
-	 * @param size the size 
+	 * @param page the page
+	 * @param size the size
 	 * @param sort the sort
 	 */
 	public DefaultPageable(int page, int size, List<String> sort) {

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/Pageable.java

@@ -61,8 +61,8 @@ public class Pageable {
 	/**
 	 * Instantiates a new Pageable.
 	 *
-	 * @param page the page 
-	 * @param size the size 
+	 * @param page the page
+	 * @param size the size
 	 * @param sort the sort
 	 */
 	public Pageable(int page, int size, List<String> sort) {

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/ActuatorOpenApiCustomiser.java

@@ -19,6 +19,9 @@
  */
 public class ActuatorOpenApiCustomiser implements OpenApiCustomiser {
 
+	/**
+	 * The Path pathern.
+	 */
 	private final Pattern pathPathern = Pattern.compile("\\{(.*?)}");
 
 	@Override

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/DelegatingMethodParameterCustomizer.java

@@ -0,0 +1,19 @@
+package org.springdoc.core.customizers;
+
+import org.springframework.core.MethodParameter;
+
+/**
+ * The interface Delegating method parameter customizer.
+ */
+@FunctionalInterface
+public interface DelegatingMethodParameterCustomizer {
+
+	/**
+	 * Customize.
+	 *
+	 * @param originalParameter the original parameter
+	 * @param methodParameter the method parameter
+	 */
+	void customize(MethodParameter originalParameter, MethodParameter methodParameter);
+
+}

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/ParameterCustomizer.java

@@ -34,8 +34,8 @@ public interface ParameterCustomizer {
 	/**
 	 * Customize parameter.
 	 *
-	 * @param parameterModel to be customized 
-	 * @param methodParameter original parameter from handler method 
+	 * @param parameterModel to be customized
+	 * @param methodParameter original parameter from handler method
 	 * @return customized parameter
 	 */
 	Parameter customize(Parameter parameterModel, MethodParameter methodParameter);

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/AbstractRouterFunctionVisitor.java

@@ -64,7 +64,7 @@ public void path(String pattern) {
 	/**
 	 * Header.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void header(String name, String value) {
@@ -88,7 +88,7 @@ public List<RouterFunctionData> getRouterFunctionDatas() {
 	/**
 	 * Query param.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void queryParam(String name, String value) {
@@ -107,7 +107,7 @@ public void pathExtension(String extension) {
 	/**
 	 * Param.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void param(String name, String value) {

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/RouterFunctionData.java

@@ -99,7 +99,7 @@ public Map<String, String> getQueryParams() {
 	/**
 	 * Add query params.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void addQueryParams(String name, String value) {

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/RouterOperation.java

@@ -112,7 +112,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 	/**
 	 * Instantiates a new Router operation.
 	 *
-	 * @param routerOperationAnnotation the router operation annotation 
+	 * @param routerOperationAnnotation the router operation annotation
 	 * @param routerFunctionData the router function data
 	 */
 	public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOperationAnnotation, RouterFunctionData routerFunctionData) {
@@ -131,7 +131,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 	/**
 	 * Instantiates a new Router operation.
 	 *
-	 * @param path the path 
+	 * @param path the path
 	 * @param methods the methods
 	 */
 	public RouterOperation(String path, RequestMethod[] methods) {
@@ -344,7 +344,7 @@ public int compareTo(RouterOperation routerOperation) {
 			result = methods[0].compareTo(routerOperation.getMethods()[0]);
 		if (result == 0 && operationModel != null && routerOperation.getOperationModel() != null)
 			result = operationModel.getOperationId().compareTo(routerOperation.getOperationModel().getOperationId());
-		if (result == 0 && operation != null && operation.operationId() != null && routerOperation.getOperation().operationId() != null)
+		if (result == 0 && operation != null)
 			result = operation.operationId().compareTo(routerOperation.getOperation().operationId());
 		return result;
 	}