Add support for none required fields on @ParameterObject. Fixes #541

Author: bnasslahsen

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

@@ -17,6 +17,7 @@
 import java.util.Objects;
 import java.util.stream.Stream;
 
+import io.swagger.v3.oas.annotations.Parameter;
 import org.apache.commons.lang3.ArrayUtils;
 import org.springdoc.api.annotations.ParameterObject;
 import org.springdoc.core.converters.AdditionalModelsConverter;
@@ -141,16 +142,24 @@ public void initParameterNameDiscovery(ParameterNameDiscoverer parameterNameDisc
 	@Nullable
 	static MethodParameter fromGetterOfField(Class<?> paramClass, Field field) {
 		try {
+			Annotation[] filedAnnotations = field.getDeclaredAnnotations();
+			Parameter parameter = field.getAnnotation(Parameter.class);
+			if (parameter != null && !parameter.required()) {
+				Field fieldNullable = NullableFieldClass.class.getDeclaredField("nullableField");
+				Annotation annotation = fieldNullable.getAnnotation(Nullable.class);
+				filedAnnotations = ArrayUtils.add(filedAnnotations, annotation);
+			}
+			Annotation[] filedAnnotationsNew = filedAnnotations;
 			return Stream.of(Introspector.getBeanInfo(paramClass).getPropertyDescriptors())
 					.filter(d -> d.getName().equals(field.getName()))
 					.map(PropertyDescriptor::getReadMethod)
 					.filter(Objects::nonNull)
 					.findFirst()
 					.map(method -> new MethodParameter(method, -1))
-					.map(param -> new DelegatingMethodParameter(param, field.getName(), field.getDeclaredAnnotations()))
+					.map(param -> new DelegatingMethodParameter(param, field.getName(), filedAnnotationsNew))
 					.orElse(null);
 		}
-		catch (IntrospectionException e) {
+		catch (IntrospectionException | NoSuchFieldException e) {
 			return null;
 		}
 	}
@@ -172,4 +181,9 @@ public int hashCode() {
 		result = 31 * result + Arrays.hashCode(additionalParameterAnnotations);
 		return result;
 	}
+
+	private class NullableFieldClass {
+		@Nullable
+		private String nullableField;
+	}
 }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app102/RequestParams.java

@@ -1,17 +1,29 @@
 package test.org.springdoc.api.app102;
 
+import java.util.Optional;
+
 import io.swagger.v3.oas.annotations.Parameter;
 
 import org.springframework.lang.Nullable;
 
 public class RequestParams {
-	@Nullable
+
 	@Parameter(description = "string parameter")
 	private String stringParam;
 
+	private String stringParam1;
+
+	@Parameter(description = "string parameter2", required = true)
+	private String stringParam2;
+
 	@Parameter(description = "int parameter")
 	private int intParam;
 
+	private Optional<String> intParam2;
+
+	@Nullable
+	private String intParam3;
+
 	public String getStringParam() {
 		return stringParam;
 	}
@@ -27,4 +39,37 @@ public int getIntParam() {
 	public void setIntParam(int intParam) {
 		this.intParam = intParam;
 	}
+
+	public Optional<String> getIntParam2() {
+		return intParam2;
+	}
+
+	public void setIntParam2(Optional<String> intParam2) {
+		this.intParam2 = intParam2;
+	}
+
+	@Nullable
+	public String getIntParam3() {
+		return intParam3;
+	}
+
+	public void setIntParam3(@Nullable String intParam3) {
+		this.intParam3 = intParam3;
+	}
+
+	public String getStringParam1() {
+		return stringParam1;
+	}
+
+	public void setStringParam1(String stringParam1) {
+		this.stringParam1 = stringParam1;
+	}
+
+	public String getStringParam2() {
+		return stringParam2;
+	}
+
+	public void setStringParam2(String stringParam2) {
+		this.stringParam2 = stringParam2;
+	}
 }

springdoc-openapi-webmvc-core/src/test/resources/results/app102.json

@@ -35,15 +35,48 @@
               "type": "string"
             }
           },
+          {
+            "name": "stringParam1",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "stringParam2",
+            "in": "query",
+            "description": "string parameter2",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "intParam",
             "in": "query",
             "description": "int parameter",
-            "required": true,
+            "required": false,
             "schema": {
               "type": "integer",
               "format": "int32"
             }
+          },
+          {
+            "name": "intParam2",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "intParam3",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -55,4 +88,4 @@
     }
   },
   "components": {}
-}
+}