Add support for placeholders for default value in @RequestParam Annotation. Fixes #904.

Author: bnasslahsen

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

@@ -65,10 +65,8 @@
 import org.springframework.util.CollectionUtils;
 import org.springframework.validation.BindingResult;
 import org.springframework.validation.Errors;
-import org.springframework.web.bind.annotation.CookieValue;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestAttribute;
-import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ValueConstants;
@@ -245,7 +243,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 					io.swagger.v3.oas.annotations.Parameter.class);
 
 			final String pName = methodParameter.getParameterName();
-			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter);
+			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter, parameterBuilder);
 
 			if (parameterDoc == null)
 				parameterDoc = parametersDocMap.get(parameterInfo.getpName());
@@ -412,40 +410,23 @@ public boolean isValidParameter(Parameter parameter) {
 	public Parameter buildParams(ParameterInfo parameterInfo, Components components,
 			RequestMethod requestMethod, JsonView jsonView) {
 		MethodParameter methodParameter = parameterInfo.getMethodParameter();
-		RequestHeader requestHeader = parameterInfo.getRequestHeader();
-		RequestParam requestParam = parameterInfo.getRequestParam();
-		PathVariable pathVar = parameterInfo.getPathVar();
-		CookieValue cookieValue = parameterInfo.getCookieValue();
-
-		RequestInfo requestInfo;
-
-		if (requestHeader != null) {
-			requestInfo = new RequestInfo(ParameterIn.HEADER.toString(), parameterInfo.getpName(), requestHeader.required(),
-					requestHeader.defaultValue());
-			return buildParam(parameterInfo, components, requestInfo, jsonView);
-
-		}
-		else if (requestParam != null && !parameterBuilder.isFile(parameterInfo.getMethodParameter())) {
-			requestInfo = new RequestInfo(ParameterIn.QUERY.toString(), parameterInfo.getpName(), requestParam.required() && !methodParameter.isOptional(),
-					requestParam.defaultValue());
-			return buildParam(parameterInfo, components, requestInfo, jsonView);
-		}
-		else if (pathVar != null) {
-			requestInfo = new RequestInfo(ParameterIn.PATH.toString(), parameterInfo.getpName(), !methodParameter.isOptional(), null);
-			return buildParam(parameterInfo, components, requestInfo, jsonView);
-		}
-		else if (cookieValue != null) {
-			requestInfo = new RequestInfo(ParameterIn.COOKIE.toString(), parameterInfo.getpName(), cookieValue.required(),
-					cookieValue.defaultValue());
-			return buildParam(parameterInfo, components, requestInfo, jsonView);
+		if (parameterInfo.getParamType() != null){
+			if (!ValueConstants.DEFAULT_NONE.equals(parameterInfo.getDefaultValue()))
+				parameterInfo.setRequired(false);
+			else
+				parameterInfo.setDefaultValue(null);
+			return this.buildParam(parameterInfo, components, jsonView);
 		}
 		// By default
 		DelegatingMethodParameter delegatingMethodParameter = (DelegatingMethodParameter) methodParameter;
 		if (RequestMethod.GET.equals(requestMethod)
 				|| (parameterInfo.getParameterModel() != null && (ParameterIn.PATH.toString().equals(parameterInfo.getParameterModel().getIn())))
-				|| delegatingMethodParameter.isParameterObject())
-			return this.buildParam(QUERY_PARAM, components, parameterInfo, !methodParameter.isOptional(), null, jsonView);
-
+				|| delegatingMethodParameter.isParameterObject()){
+			parameterInfo.setRequired(!methodParameter.isOptional());
+			parameterInfo.setParamType(QUERY_PARAM);
+			parameterInfo.setDefaultValue(null);
+			return this.buildParam(parameterInfo, components, jsonView);
+		}
 		return null;
 	}
 
@@ -454,39 +435,10 @@ else if (cookieValue != null) {
 	 *
 	 * @param parameterInfo the parameter info
 	 * @param components the components
-	 * @param requestInfo the request info
-	 * @param jsonView the json view
-	 * @return the parameter
-	 */
-	private Parameter buildParam(ParameterInfo parameterInfo, Components components, RequestInfo requestInfo,
-			JsonView jsonView) {
-		Parameter parameter;
-		String pName = parameterInfo.getpName();
-		String name = StringUtils.isBlank(requestInfo.value()) ? pName : requestInfo.value();
-		parameterInfo.setpName(name);
-
-		if (!ValueConstants.DEFAULT_NONE.equals(requestInfo.defaultValue()))
-			parameter = this.buildParam(requestInfo.type(), components, parameterInfo, false,
-					requestInfo.defaultValue(), jsonView);
-		else
-			parameter = this.buildParam(requestInfo.type(), components, parameterInfo, requestInfo.required(), null,
-					jsonView);
-		return parameter;
-	}
-
-	/**
-	 * Build param parameter.
-	 *
-	 * @param in the in
-	 * @param components the components
-	 * @param parameterInfo the parameter info
-	 * @param required the required
-	 * @param defaultValue the default value
 	 * @param jsonView the json view
 	 * @return the parameter
 	 */
-	private Parameter buildParam(String in, Components components, ParameterInfo parameterInfo, Boolean required,
-			String defaultValue, JsonView jsonView) {
+	private Parameter buildParam(ParameterInfo parameterInfo, Components components, JsonView jsonView) {
 		Parameter parameter = parameterInfo.getParameterModel();
 		String name = parameterInfo.getpName();
 
@@ -499,19 +451,19 @@ private Parameter buildParam(String in, Components components, ParameterInfo par
 			parameter.setName(name);
 
 		if (StringUtils.isBlank(parameter.getIn()))
-			parameter.setIn(in);
+			parameter.setIn(parameterInfo.getParamType());
 
-		if (required != null && parameter.getRequired() == null)
-			parameter.setRequired(required);
+		if (parameter.getRequired() == null)
+			parameter.setRequired(parameterInfo.isRequired());
 
 		if (containsDeprecatedAnnotation(parameterInfo.getMethodParameter().getParameterAnnotations()))
 			parameter.setDeprecated(true);
 
 		if (parameter.getSchema() == null && parameter.getContent() == null) {
 			Schema<?> schema = parameterBuilder.calculateSchema(components, parameterInfo, null,
 					jsonView);
-			if (defaultValue != null)
-				schema.setDefault(defaultValue);
+			if (parameterInfo.getDefaultValue() != null)
+				schema.setDefault(parameterInfo.getDefaultValue());
 			parameter.setSchema(schema);
 		}
 		return parameter;

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

@@ -449,4 +449,13 @@ else if (type instanceof WildcardType) {
 		}
 		return false;
 	}
+
+	/**
+	 * Gets property resolver utils.
+	 *
+	 * @return the property resolver utils
+	 */
+	public PropertyResolverUtils getPropertyResolverUtils() {
+		return propertyResolverUtils;
+	}
 }

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

@@ -22,6 +22,7 @@
 
 import java.lang.reflect.Parameter;
 
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import org.apache.commons.lang3.StringUtils;
 
 import org.springframework.core.MethodParameter;
@@ -52,38 +53,54 @@ public class ParameterInfo {
 	private io.swagger.v3.oas.models.parameters.Parameter parameterModel;
 
 	/**
-	 * The Request header.
+	 * The Required.
 	 */
-	private RequestHeader requestHeader;
+	private boolean required;
 
 	/**
-	 * The Request param.
+	 * The Default value.
 	 */
-	private RequestParam requestParam;
+	private String defaultValue;
 
 	/**
-	 * The Path var.
+	 * The Param type.
 	 */
-	private PathVariable pathVar;
+	private String paramType;
 
-	/**
-	 * The Cookie value.
-	 */
-	private CookieValue cookieValue;
 
 	/**
 	 * Instantiates a new Parameter info.
 	 *
-	 * @param pName the p name
+	 * @param pName the parameter name
 	 * @param methodParameter the method parameter
+	 * @param parameterBuilder the parameter builder
 	 */
-	public ParameterInfo(String pName, MethodParameter methodParameter) {
+	public ParameterInfo(String pName, MethodParameter methodParameter, GenericParameterBuilder parameterBuilder) {
+		PropertyResolverUtils propertyResolverUtils = parameterBuilder.getPropertyResolverUtils();
+		RequestHeader requestHeader = methodParameter.getParameterAnnotation(RequestHeader.class);
+		RequestParam requestParam = methodParameter.getParameterAnnotation(RequestParam.class);
+		PathVariable pathVar = methodParameter.getParameterAnnotation(PathVariable.class);
+		CookieValue cookieValue = methodParameter.getParameterAnnotation(CookieValue.class);
+		boolean isFile = parameterBuilder.isFile(methodParameter);
+
 		this.methodParameter = methodParameter;
-		this.requestHeader = methodParameter.getParameterAnnotation(RequestHeader.class);
-		this.requestParam = methodParameter.getParameterAnnotation(RequestParam.class);
-		this.pathVar = methodParameter.getParameterAnnotation(PathVariable.class);
-		this.cookieValue = methodParameter.getParameterAnnotation(CookieValue.class);
-		this.pName = calculateName(pName, requestHeader, requestParam, pathVar, cookieValue);
+		this.pName = pName;
+
+		if (requestHeader != null)
+			calculateParams(requestHeader);
+		else if (requestParam != null)
+			calculateParams(requestParam, isFile);
+		else if (pathVar != null)
+			calculateParams(pathVar);
+		else if (cookieValue != null)
+			calculateParams(cookieValue);
+
+		if (StringUtils.isNotBlank(this.pName))
+			this.pName = propertyResolverUtils.resolve(this.pName);
+		if (StringUtils.isNotBlank(this.defaultValue))
+			this.defaultValue = propertyResolverUtils.resolve(this.defaultValue);
+
+		this.required = this.required && !methodParameter.isOptional();
 	}
 
 	/**
@@ -141,61 +158,109 @@ public void setParameterModel(io.swagger.v3.oas.models.parameters.Parameter para
 	}
 
 	/**
-	 * Gets request header.
+	 * Is required boolean.
 	 *
-	 * @return the request header
+	 * @return the boolean
 	 */
-	public RequestHeader getRequestHeader() {
-		return requestHeader;
+	public boolean isRequired() {
+		return required;
 	}
 
 	/**
-	 * Gets request param.
+	 * Gets default value.
 	 *
-	 * @return the request param
+	 * @return the default value
 	 */
-	public RequestParam getRequestParam() {
-		return requestParam;
+	public String getDefaultValue() {
+		return defaultValue;
 	}
 
 	/**
-	 * Gets path var.
+	 * Gets param type.
 	 *
-	 * @return the path var
+	 * @return the param type
 	 */
-	public PathVariable getPathVar() {
-		return pathVar;
+	public String getParamType() {
+		return paramType;
 	}
 
 	/**
-	 * Gets cookie value.
+	 * Sets param type.
 	 *
-	 * @return the cookie value
+	 * @param paramType the param type
 	 */
-	public CookieValue getCookieValue() {
-		return cookieValue;
+	public void setParamType(String paramType) {
+		this.paramType = paramType;
 	}
 
 	/**
-	 * Calculate name string.
+	 * Sets required.
+	 *
+	 * @param required the required
+	 */
+	public void setRequired(boolean required) {
+		this.required = required;
+	}
+
+	/**
+	 * Sets default value.
+	 *
+	 * @param defaultValue the default value
+	 */
+	public void setDefaultValue(String defaultValue) {
+		this.defaultValue = defaultValue;
+	}
+
+	/**
+	 * Calculate params.
 	 *
-	 * @param pName the p name
-	 * @param requestHeader the request header
-	 * @param requestParam the request param
-	 * @param pathVar the path var
 	 * @param cookieValue the cookie value
-	 * @return the string
-	 */
-	private String calculateName(String pName, RequestHeader requestHeader, RequestParam requestParam, PathVariable pathVar, CookieValue cookieValue) {
-		String name = pName;
-		if (requestHeader != null && StringUtils.isNotEmpty(requestHeader.value()))
-			name = requestHeader.value();
-		else if (requestParam != null && StringUtils.isNotEmpty(requestParam.value()))
-			name = requestParam.value();
-		else if (pathVar != null && StringUtils.isNotEmpty(pathVar.value()))
-			name = pathVar.value();
-		else if (cookieValue != null && StringUtils.isNotEmpty(cookieValue.value()))
-			name = cookieValue.value();
-		return name;
+	 */
+	private void calculateParams(CookieValue cookieValue) {
+		if (StringUtils.isNotEmpty(cookieValue.value()))
+			this.pName = cookieValue.value();
+		this.required = cookieValue.required();
+		this.defaultValue = cookieValue.defaultValue();
+		this.paramType = ParameterIn.COOKIE.toString();
+	}
+
+	/**
+	 * Calculate params.
+	 *
+	 * @param pathVar the path var
+	 */
+	private void calculateParams(PathVariable pathVar) {
+		if (StringUtils.isNotEmpty(pathVar.value()))
+			this.pName = pathVar.value();
+		this.required = pathVar.required();
+		this.paramType = ParameterIn.PATH.toString();
+	}
+
+	/**
+	 * Calculate params.
+	 *
+	 * @param requestParam the request param
+	 * @param isFile the is file
+	 */
+	private void calculateParams(RequestParam requestParam, boolean isFile) {
+		if (StringUtils.isNotEmpty(requestParam.value()))
+			this.pName = requestParam.value();
+		this.required = requestParam.required();
+		this.defaultValue = requestParam.defaultValue();
+		if (!isFile)
+			this.paramType = ParameterIn.QUERY.toString();
+	}
+
+	/**
+	 * Calculate params.
+	 *
+	 * @param requestHeader the request header
+	 */
+	private void calculateParams(RequestHeader requestHeader) {
+		if (StringUtils.isNotEmpty(requestHeader.value()))
+			this.pName = requestHeader.value();
+		this.required = requestHeader.required();
+		this.defaultValue = requestHeader.defaultValue();
+		this.paramType = ParameterIn.HEADER.toString();
 	}
 }