Changes report: #1706

Author: bnasslahsen

.gitignore

@@ -127,6 +127,7 @@ Desktop.ini
 *.*~
 *~
 .merge_file*
+.java-version
 
 ######################
 # Gradle Wrapper

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -74,6 +74,7 @@
 import org.springdoc.core.customizers.OpenApiCustomizer;
 import org.springdoc.core.customizers.OpenApiLocaleCustomizer;
 import org.springdoc.core.customizers.OperationCustomizer;
+import org.springdoc.core.customizers.RouterOperationCustomizer;
 import org.springdoc.core.filters.OpenApiMethodFilter;
 import org.springdoc.core.fn.AbstractRouterFunctionVisitor;
 import org.springdoc.core.fn.RouterFunctionData;
@@ -177,6 +178,10 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 */
 	private final Optional<List<OperationCustomizer>> operationCustomizers;
 
+	/**
+	 * The RouterOperation customizers.
+	 */
+	private final Optional<List<RouterOperationCustomizer>> routerOperationCustomizers;
 	/**
 	 * The method filters to use.
 	 */
@@ -216,6 +221,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 * @param operationParser the operation parser
 	 * @param operationCustomizers the operation customizers
 	 * @param openApiCustomizers the open api customisers
+	 * @param routerOperationCustomizers the router operation customisers
 	 * @param methodFilters the method filters
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @param springDocProviders the spring doc providers
@@ -225,6 +231,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
 			GenericResponseService responseBuilder, OperationService operationParser,
 			Optional<List<OperationCustomizer>> operationCustomizers,
 			Optional<List<OpenApiCustomizer>> openApiCustomizers,
+			Optional<List<RouterOperationCustomizer>> routerOperationCustomizers,
 			Optional<List<OpenApiMethodFilter>> methodFilters,
 			SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
 		super();
@@ -235,6 +242,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
 		this.responseBuilder = responseBuilder;
 		this.operationParser = operationParser;
 		this.openApiCustomizers = openApiCustomizers;
+		this.routerOperationCustomizers = routerOperationCustomizers;
 		this.methodFilters = methodFilters;
 		this.springDocProviders = springDocProviders;
 		//add the default customizers
@@ -366,6 +374,8 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 	 * @param openAPI the open api
 	 */
 	protected void calculatePath(HandlerMethod handlerMethod, RouterOperation routerOperation, Locale locale, OpenAPI openAPI) {
+		routerOperation = customizeRouterOperation(routerOperation, handlerMethod);
+
 		String operationPath = routerOperation.getPath();
 		Set<RequestMethod> requestMethods = new HashSet<>(Arrays.asList(routerOperation.getMethods()));
 		io.swagger.v3.oas.annotations.Operation apiOperation = routerOperation.getOperation();
@@ -596,8 +606,8 @@ protected void calculatePath(RouterOperation routerOperation, Locale locale, Ope
 	 * @param locale the locale
 	 */
 	protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
-			Set<RequestMethod> requestMethods,String[] consumes, String[] produces, String[] headers, Locale locale, OpenAPI openAPI) {
-		this.calculatePath(handlerMethod, new RouterOperation(operationPath, requestMethods.toArray(new RequestMethod[requestMethods.size()]), consumes, produces, headers), locale, openAPI);
+			Set<RequestMethod> requestMethods,String[] consumes, String[] produces, String[] headers, String[] params,Locale locale, OpenAPI openAPI) {
+		this.calculatePath(handlerMethod, new RouterOperation(operationPath, requestMethods.toArray(new RequestMethod[requestMethods.size()]), consumes, produces, headers, params), locale, openAPI);
 	}
 
 	/**
@@ -833,6 +843,21 @@ protected Operation customiseOperation(Operation operation, HandlerMethod handle
 		return operation;
 	}
 
+	/**
+	 * Customise router operation
+	 * @param routerOperation
+	 * @param handlerMethod
+	 * @return the router operation
+	 */
+	protected RouterOperation customizeRouterOperation(RouterOperation routerOperation, HandlerMethod handlerMethod) {
+		if (routerOperationCustomizers.isPresent()) {
+			List<RouterOperationCustomizer> routerOperationCustomizerList = routerOperationCustomizers.get();
+			for (RouterOperationCustomizer routerOperationCustomizer : routerOperationCustomizerList) {
+				routerOperation = routerOperationCustomizer.customize(routerOperation, handlerMethod);
+			}
+		}
+		return routerOperation;
+	}
 	/**
 	 * Merge routers.
 	 *

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

@@ -97,6 +97,14 @@
 	 */
 	String[] headers() default {};
 
+	/**
+	 * The parameters of the mapped request, narrowing the primary mapping.
+	 * Same format for any environment: a sequence of "myParam=myValue" style expressions,
+	 * with a request only mapped if each such parameter is found to have the given value.
+	 * @return the string [ ]
+	 */
+	String[] params() default {};
+
 	/**
 	 * The class of the Handler bean.
 	 * @return the class of the Bean

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

@@ -0,0 +1,25 @@
+package org.springdoc.core.customizers;
+
+import org.springdoc.core.fn.RouterOperation;
+
+import org.springframework.web.method.HandlerMethod;
+
+/**
+ * Implement and register a bean of type {@link RouterOperationCustomizer} to customize an router operation
+ * based on the handler method input on default OpenAPI descriptions but not groups
+ *
+ * @author hyeonisism
+ */
+@FunctionalInterface
+public interface RouterOperationCustomizer {
+
+	/**
+	 * Customize router operation.
+	 *
+	 * @param routerOperation input operation
+	 * @param handlerMethod original handler method
+	 * @return customized router operation
+	 */
+	RouterOperation customize(RouterOperation routerOperation, HandlerMethod handlerMethod);
+
+}

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

@@ -281,7 +281,7 @@ else if (ControllerType.PROPERTY.equals(controllerType))
 			MethodResourceMapping methodResourceMapping, HandlerMethod handlerMethod,
 			RequestMethod requestMethod, ResourceMetadata resourceMetadata, String
 			operationPath, ControllerType controllerType) {
-		RouterOperation routerOperation = new RouterOperation(operationPath, new RequestMethod[] { requestMethod }, null, null, null);
+		RouterOperation routerOperation = new RouterOperation(operationPath, new RequestMethod[] { requestMethod }, null, null, null,null);
 		MethodAttributes methodAttributes = new MethodAttributes(springDocConfigProperties.getDefaultConsumesMediaType(), springDocConfigProperties.getDefaultProducesMediaType(), dataRestRepository.getLocale());
 		methodAttributes.calculateConsumesProduces(handlerMethod.getMethod());
 		routerOperation.setConsumes(methodAttributes.getMethodConsumes());

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

@@ -44,6 +44,7 @@
  */
 public class RouterFunctionData {
 
+
 	/**
 	 * The Path.
 	 */
@@ -64,6 +65,11 @@ public class RouterFunctionData {
 	 */
 	private List<String> headers = new ArrayList<>();
 
+	/**
+	 * The Params.
+	 */
+	private List<String> params = new ArrayList<>();
+
 	/**
 	 * The Query params.
 	 */
@@ -77,13 +83,12 @@ public class RouterFunctionData {
 	/**
 	 * The Attributes.
 	 */
-	private Map<String, Object> attributes = new LinkedHashMap<>();
+	private Map<String,Object> attributes = new LinkedHashMap<>();
 
 	/**
 	 * Instantiates a new Router function data.
 	 */
-	public RouterFunctionData() {
-	}
+	public RouterFunctionData() { }
 
 	/**
 	 * Instantiates a new Router function data.
@@ -96,6 +101,7 @@ public RouterFunctionData(String nestedOrPath, RouterFunctionData functionData)
 		this.consumes = Arrays.asList(functionData.getConsumes());
 		this.produces = Arrays.asList(functionData.getProduces());
 		this.headers = Arrays.asList(functionData.getHeaders());
+		this.params = Arrays.asList(functionData.getParams());
 		this.queryParams = functionData.getQueryParams();
 		this.methods = functionData.getMethods();
 		this.attributes = functionData.getAttributes();
@@ -184,6 +190,20 @@ public String[] getConsumes() {
 		return consumes.toArray(new String[consumes.size()]);
 	}
 
+	/**
+	 * Get params string [ ].
+	 *
+	 * @return the string [ ]
+	 */
+	public String[] getParams() { return params.toArray(new String[params.size()]); }
+
+	/**
+	 * Add params.
+	 *
+	 * @param params the params
+	 */
+	public void addParams(String params) { if(StringUtils.isNotBlank(params)) this.params.add(params); }
+
 	/**
 	 * Add consumes.
 	 *

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

@@ -24,6 +24,7 @@
 
 package org.springdoc.core.fn;
 
+
 import java.util.Arrays;
 import java.util.Map;
 import java.util.Objects;
@@ -68,6 +69,11 @@ public class RouterOperation implements Comparable<RouterOperation> {
 	 */
 	private String[] headers;
 
+	/**
+	 * The Params.
+	 */
+	private String[] params;
+
 	/**
 	 * The Bean class.
 	 */
@@ -118,6 +124,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 		this.parameterTypes = routerOperationAnnotation.parameterTypes();
 		this.operation = routerOperationAnnotation.operation();
 		this.headers = routerOperationAnnotation.headers();
+		this.params = routerOperationAnnotation.params();
 	}
 
 	/**
@@ -136,6 +143,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 		this.parameterTypes = routerOperationAnnotation.parameterTypes();
 		this.operation = routerOperationAnnotation.operation();
 		this.headers = ArrayUtils.isEmpty(routerOperationAnnotation.headers()) ? routerFunctionData.getHeaders() : routerOperationAnnotation.headers();
+		this.params = routerOperationAnnotation.params();
 		this.queryParams = routerFunctionData.getQueryParams();
 	}
 
@@ -148,12 +156,13 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 	 * @param produces the produces
 	 * @param headers the headers
 	 */
-	public RouterOperation(String path, RequestMethod[] methods,String[] consumes, String[] produces, String[] headers) {
+	public RouterOperation(String path, RequestMethod[] methods, String[] consumes, String[] produces, String[] headers, String[] params) {
 		this.path = path;
 		this.methods = methods;
-		this.consumes=consumes;
-		this.produces=produces;
-		this.headers=headers;
+		this.consumes = consumes;
+		this.produces = produces;
+		this.headers = headers;
+		this.params = params;
 	}
 
 	/**
@@ -167,6 +176,7 @@ public RouterOperation(RouterFunctionData routerFunctionData) {
 		this.consumes = routerFunctionData.getConsumes();
 		this.produces = routerFunctionData.getProduces();
 		this.headers = routerFunctionData.getHeaders();
+		this.params = routerFunctionData.getParams();
 		this.queryParams = routerFunctionData.getQueryParams();
 
 		Map<String, Object> attributes = routerFunctionData.getAttributes();
@@ -371,6 +381,24 @@ public void setQueryParams(Map<String, String> queryParams) {
 		this.queryParams = queryParams;
 	}
 
+	/**
+	 * Gets params.
+	 *
+	 * @return the params
+	 */
+	public String[] getParams() {
+		return this.params;
+	}
+
+	/**
+	 * Sets params.
+	 *
+	 * @param params
+	 */
+	public void setParams(String[] params) {
+		this.params = params;
+	}
+
 	/**
 	 * Gets operation model.
 	 *
@@ -411,6 +439,7 @@ public boolean equals(Object o) {
 				Arrays.equals(consumes, that.consumes) &&
 				Arrays.equals(produces, that.produces) &&
 				Arrays.equals(headers, that.headers) &&
+				Arrays.equals(params, that.params) &&
 				Objects.equals(beanClass, that.beanClass) &&
 				Objects.equals(beanMethod, that.beanMethod) &&
 				Arrays.equals(parameterTypes, that.parameterTypes) &&
@@ -423,6 +452,7 @@ public boolean equals(Object o) {
 	public int hashCode() {
 		int result = Objects.hash(path, beanClass, beanMethod, queryParams, operation, operationModel);
 		result = 31 * result + Arrays.hashCode(methods);
+		result = 31 * result + Arrays.hashCode(params);
 		result = 31 * result + Arrays.hashCode(consumes);
 		result = 31 * result + Arrays.hashCode(produces);
 		result = 31 * result + Arrays.hashCode(headers);

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/models/GroupedOpenApi.java

@@ -33,6 +33,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.springdoc.core.customizers.OpenApiCustomizer;
 import org.springdoc.core.customizers.OperationCustomizer;
+import org.springdoc.core.customizers.RouterOperationCustomizer;
 import org.springdoc.core.filters.OpenApiMethodFilter;
 
 import org.springframework.util.CollectionUtils;
@@ -60,6 +61,11 @@ public class GroupedOpenApi {
 	 */
 	private List<OperationCustomizer> operationCustomizers;
 
+	/**
+	 * The Router Operation customizers.
+	 */
+	private List<RouterOperationCustomizer> routerOperationCustomizers;
+
 	/**
 	 * The Paths to match.
 	 */
@@ -122,6 +128,7 @@ private GroupedOpenApi(Builder builder) {
 		this.displayName = StringUtils.defaultIfEmpty(builder.displayName, this.group);
 		this.openApiCustomizers = Objects.requireNonNull(builder.openApiCustomizers);
 		this.operationCustomizers = Objects.requireNonNull(builder.operationCustomizers);
+		this.routerOperationCustomizers = Objects.requireNonNull(builder.routerOperationCustomizers);
 		this.openApiMethodFilters = Objects.requireNonNull(builder.methodFilters);
 		if (CollectionUtils.isEmpty(this.pathsToMatch)
 				&& CollectionUtils.isEmpty(this.packagesToScan)
@@ -244,6 +251,15 @@ public List<OpenApiMethodFilter> getOpenApiMethodFilters() {
 		return openApiMethodFilters;
 	}
 
+	/**
+	 * Gets router operation customizers.
+	 *
+	 * @return the router operation customizers
+	 */
+	public List<RouterOperationCustomizer> getRouterOperationCustomizers() {
+		return routerOperationCustomizers;
+	}
+
 	/**
 	 * Gets display name.
 	 *
@@ -268,6 +284,11 @@ public static class Builder {
 		 */
 		private final List<OperationCustomizer> operationCustomizers = new ArrayList<>();
 
+		/**
+		 * The Router Operation customizers.
+		 */
+		private final List<RouterOperationCustomizer> routerOperationCustomizers = new ArrayList<>();
+
 		/**
 		 * The methods filters to apply.
 		 */
@@ -435,6 +456,17 @@ public Builder addOperationCustomizer(OperationCustomizer operationCustomizer) {
 			return this;
 		}
 
+		/**
+		 * Add router operation customizer builder
+		 *
+		 * @param routerOperationCustomizer the router operation customizer
+		 * @return the builder
+		 */
+		public Builder addRouterOperationCustomizer(RouterOperationCustomizer routerOperationCustomizer) {
+			this.routerOperationCustomizers.add(routerOperationCustomizer);
+			return this;
+		}
+
 		/**
 		 * Add method filter.
 		 *