Swagger doesn't work after custom annotation replacing request parameters. Fixes #2752

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/data/DataRestRequestService.java

@@ -65,6 +65,8 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import static org.springdoc.core.utils.SpringDocUtils.getParameterAnnotations;
+
 /**
  * The type Data rest request builder.
  *
@@ -164,7 +166,7 @@ public void buildCommonParameters(OpenAPI openAPI, RequestMethod requestMethod,
 			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter, parameterBuilder, parameterDoc);
 			if (isParamToIgnore(methodParameter)) {
 				if (PersistentEntityResource.class.equals(methodParameter.getParameterType())) {
-					Schema<?> schema = SpringDocAnnotationsUtils.resolveSchemaFromType(domainType, openAPI.getComponents(), null, methodParameter.getParameterAnnotations(), openAPI.getSpecVersion());
+					Schema<?> schema = SpringDocAnnotationsUtils.resolveSchemaFromType(domainType, openAPI.getComponents(), null, getParameterAnnotations(methodParameter), openAPI.getSpecVersion());
 					parameterInfo.setParameterModel(new Parameter().schema(schema));
 				}
 				else if (methodParameter.getParameterAnnotation(BackendId.class) != null) {
@@ -223,7 +225,7 @@ private boolean isParamToIgnore(MethodParameter methodParameter) {
 	 */
 	private void addParameters(OpenAPI openAPI, RequestMethod requestMethod, MethodAttributes methodAttributes, Operation operation,
 			MethodParameter methodParameter, ParameterInfo parameterInfo, Parameter parameter) {
-		List<Annotation> parameterAnnotations = Arrays.asList(methodParameter.getParameterAnnotations());
+		List<Annotation> parameterAnnotations = Arrays.asList(getParameterAnnotations(methodParameter));
 		if (requestBuilder.isValidParameter(parameter)) {
 			requestBuilder.applyBeanValidatorAnnotations(parameter, parameterAnnotations);
 			operation.addParametersItem(parameter);

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/AbstractRequestService.java

@@ -63,9 +63,7 @@
 import jakarta.validation.constraints.Min;
 import jakarta.validation.constraints.Pattern;
 import jakarta.validation.constraints.Size;
-import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.jetbrains.annotations.NotNull;
 import org.springdoc.core.customizers.ParameterCustomizer;
 import org.springdoc.core.discoverer.SpringDocParameterNameDiscoverer;
 import org.springdoc.core.extractor.DelegatingMethodParameter;
@@ -98,6 +96,7 @@
 import static org.springdoc.core.service.GenericParameterService.isFile;
 import static org.springdoc.core.utils.Constants.OPENAPI_ARRAY_TYPE;
 import static org.springdoc.core.utils.Constants.OPENAPI_STRING_TYPE;
+import static org.springdoc.core.utils.SpringDocUtils.getParameterAnnotations;
 import static org.springframework.http.MediaType.MULTIPART_FORM_DATA_VALUE;
 
 /**
@@ -325,7 +324,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 				// Merge with the operation parameters
 				parameter = GenericParameterService.mergeParameter(operationParameters, parameter);
 
-				List<Annotation> parameterAnnotations = getParameterAnnotations(methodParameter);
+				List<Annotation> parameterAnnotations = List.of(getParameterAnnotations(methodParameter));
 
 				if (isValidParameter(parameter)) {
 					// Add param javadoc
@@ -375,35 +374,6 @@ else if (!RequestMethod.GET.equals(requestMethod) || OpenApiVersion.OPENAPI_3_1.
 		return operation;
 	}
 
-	/**
-	 * Gets parameter annotations.
-	 *
-	 * @param methodParameter the method parameter
-	 * @return the parameter annotations
-	 */
-	@NotNull
-	private static List<Annotation> getParameterAnnotations(MethodParameter methodParameter) {
-		// Initialize the list for parameter annotations
-		List<Annotation> parameterAnnotations = new ArrayList<>();
-		// Add the parameter annotations (direct annotations)
-		if (ArrayUtils.isNotEmpty(methodParameter.getParameterAnnotations())) {
-			parameterAnnotations.addAll(Arrays.asList(methodParameter.getParameterAnnotations()));
-		}
-		// Separate list to store meta-annotations
-		List<Annotation> metaAnnotationsList = new ArrayList<>();
-		// Iterate over the direct annotations and collect meta-annotations
-		for (Annotation parameterAnnotation : parameterAnnotations) {
-			Annotation[] metaAnnotations = parameterAnnotation.annotationType().getAnnotations();
-
-			if (ArrayUtils.isNotEmpty(metaAnnotations)) {
-				metaAnnotationsList.addAll(Arrays.asList(metaAnnotations));
-			}
-		}
-		// Add all the collected meta-annotations to the main list
-		parameterAnnotations.addAll(metaAnnotationsList);
-		return parameterAnnotations;
-	}
-
 	/**
 	 * Gets parameter linked hash map.
 	 *

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/GenericParameterService.java

@@ -88,6 +88,7 @@
 import org.springframework.web.multipart.MultipartRequest;
 
 import static org.springdoc.core.utils.Constants.DOT;
+import static org.springdoc.core.utils.SpringDocUtils.getParameterAnnotations;
 
 /**
  * The type Generic parameter builder.
@@ -377,7 +378,7 @@ Schema calculateSchema(Components components, ParameterInfo parameterInfo, Reque
 						type = springConvertedType;
 				}
 			}
-			schemaN = SpringDocAnnotationsUtils.extractSchema(components, type, jsonView, methodParameter.getParameterAnnotations(), propertyResolverUtils.getSpecVersion());
+			schemaN = SpringDocAnnotationsUtils.extractSchema(components, type, jsonView, getParameterAnnotations(methodParameter), propertyResolverUtils.getSpecVersion());
 		}
 		else
 			schemaN = parameterInfo.getParameterModel().getSchema();

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/GenericResponseService.java

@@ -94,6 +94,7 @@
 import static org.springdoc.core.utils.SpringDocAnnotationsUtils.extractSchema;
 import static org.springdoc.core.utils.SpringDocAnnotationsUtils.getContent;
 import static org.springdoc.core.utils.SpringDocAnnotationsUtils.mergeSchema;
+import static org.springdoc.core.utils.SpringDocUtils.getParameterAnnotations;
 
 /**
  * The type Generic response builder.
@@ -518,7 +519,7 @@ public Set<io.swagger.v3.oas.annotations.responses.ApiResponse> getApiResponses(
 	 */
 	private Content buildContent(Components components, MethodParameter methodParameter, String[] methodProduces, JsonView jsonView) {
 		Type returnType = GenericTypeResolver.resolveType(methodParameter.getGenericParameterType(), methodParameter.getContainingClass());
-		return buildContent(components, methodParameter.getParameterAnnotations(), methodProduces, jsonView, returnType);
+		return buildContent(components, getParameterAnnotations(methodParameter), methodProduces, jsonView, returnType);
 	}
 
 	/**
@@ -611,7 +612,7 @@ else if (CollectionUtils.isEmpty(apiResponse.getContent()))
 			Content existingContent = apiResponse.getContent();
 			Type type = GenericTypeResolver.resolveType( methodParameter.getGenericParameterType(), methodParameter.getContainingClass());
 			Schema<?> schemaN = calculateSchema(components, type,
-					methodAttributes.getJsonViewAnnotation(), methodParameter.getParameterAnnotations());
+					methodAttributes.getJsonViewAnnotation(), getParameterAnnotations(methodParameter));
 			if (schemaN != null && ArrayUtils.isNotEmpty(methodAttributes.getMethodProduces()))
 				Arrays.stream(methodAttributes.getMethodProduces()).forEach(mediaTypeStr -> mergeSchema(existingContent, schemaN, mediaTypeStr));
 		}

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SpringDocUtils.java

@@ -27,10 +27,14 @@
 package org.springdoc.core.utils;
 
 import java.lang.annotation.Annotation;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.function.Predicate;
 
 import io.swagger.v3.oas.models.media.Schema;
+import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
+import org.jetbrains.annotations.NotNull;
 import org.springdoc.api.AbstractOpenApiResource;
 import org.springdoc.core.converters.AdditionalModelsConverter;
 import org.springdoc.core.converters.ConverterUtils;
@@ -41,6 +45,8 @@
 import org.springdoc.core.service.GenericParameterService;
 import org.springdoc.core.service.GenericResponseService;
 
+import org.springframework.core.MethodParameter;
+
 /**
  * The type Spring doc utils.
  *
@@ -402,5 +408,39 @@ public SpringDocUtils addParentType(String ...parentTypes) {
 		PolymorphicModelConverter.addParentType(parentTypes);
 		return this;
 	}
+
+	/**
+	 * Gets parameter annotations.
+	 *
+	 * @param methodParameter the method parameter
+	 * @return the parameter annotations
+	 */
+	@NotNull
+	public static Annotation[] getParameterAnnotations(MethodParameter methodParameter) {
+		// Get the parameter annotations directly as an array
+		Annotation[] annotations = methodParameter.getParameterAnnotations();
+		// Return early if no annotations are found, avoiding unnecessary processing
+		if (ArrayUtils.isEmpty(annotations)) {
+			return new Annotation[0];
+		}
+		// Create a list that can contain both parameter and meta-annotations
+		List<Annotation> resultAnnotations = new ArrayList<>(annotations.length);
+
+		// Add all direct annotations
+		resultAnnotations.addAll(List.of(annotations));
+
+		// Process each direct annotation to collect its meta-annotations
+		for (Annotation annotation : annotations) {
+			// Fetch meta-annotations
+			Annotation[] metaAnnotations = annotation.annotationType().getAnnotations();
+
+			// Only add meta-annotations if they exist
+			if (ArrayUtils.isNotEmpty(metaAnnotations)) {
+				resultAnnotations.addAll(List.of(metaAnnotations));
+			}
+		}
+		// Convert the list to an array and return
+		return resultAnnotations.toArray(new Annotation[0]);
+	}
 }