springfox#778 Take @RequestParam(defaultValue) in to account when marking parameter required.

Kevin Conaway · Kevin Conaway · commit e34a133695ca · 2015-06-09T11:21:31.000-04:00
diff --git a/springfox-spring-web/src/main/java/springfox/documentation/spring/web/readers/parameter/ParameterRequiredReader.java b/springfox-spring-web/src/main/java/springfox/documentation/spring/web/readers/parameter/ParameterRequiredReader.java
@@ -27,6 +27,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.ValueConstants;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spi.service.ParameterBuilderPlugin;
 import springfox.documentation.spi.service.contexts.ParameterContext;
@@ -59,7 +60,7 @@ private Boolean getAnnotatedRequired(MethodParameter methodParameter) {
 
     for (Annotation annotation : methodAnnotations) {
       if (annotation instanceof RequestParam) {
-        requiredSet.add(!optional && ((RequestParam) annotation).required());
+        requiredSet.add(!optional && isRequired((RequestParam) annotation));
       } else if (annotation instanceof RequestHeader) {
         requiredSet.add(!optional && ((RequestHeader) annotation).required());
       } else if (annotation instanceof PathVariable) {
@@ -74,4 +75,14 @@ private Boolean getAnnotatedRequired(MethodParameter methodParameter) {
   private boolean isOptional(MethodParameter methodParameter) {
     return methodParameter.getParameterType().getName().equals("java.util.Optional");
   }
+
+  private boolean isRequired(RequestParam annotation) {
+    String defaultValue = annotation.defaultValue();
+    boolean missingDefaultValue = ValueConstants.DEFAULT_NONE.equals(defaultValue) ||
+            (defaultValue == null || defaultValue.length() == 0);
+    if (annotation.required()) {
+      return missingDefaultValue;
+    }
+    return false;
+  }
 }
diff --git a/springfox-spring-web/src/test/groovy/springfox/documentation/spring/web/readers/parameter/ParameterRequiredReaderSpec.groovy b/springfox-spring-web/src/test/groovy/springfox/documentation/spring/web/readers/parameter/ParameterRequiredReaderSpec.groovy
@@ -25,6 +25,7 @@ import org.springframework.web.bind.annotation.PathVariable
 import org.springframework.web.bind.annotation.RequestBody
 import org.springframework.web.bind.annotation.RequestHeader
 import org.springframework.web.bind.annotation.RequestParam
+import org.springframework.web.bind.annotation.ValueConstants
 import springfox.documentation.builders.ParameterBuilder
 import springfox.documentation.spi.DocumentationType
 import springfox.documentation.spi.schema.GenericTypeNamingStrategy
@@ -62,13 +63,27 @@ class ParameterRequiredReaderSpec extends DocumentationContextSpec {
       [[required: { -> false }] as RequestHeader]                                       | false
       [[required: { -> true }] as ApiParam]                                             | false
       [[required: { -> false }] as ApiParam]                                            | false
-      [[required: { -> true }] as RequestParam]                                         | true
-      [[required: { -> false }] as RequestParam]                                        | false
-      [[required: { -> true }] as ApiParam, [required: { -> false }] as RequestParam]   | false
-      [[required: { -> false }] as ApiParam, [required: { -> true }] as RequestParam]   | true
+      [[required: { -> true },
+        defaultValue: { -> ValueConstants.DEFAULT_NONE}] as RequestParam]               | true
+      [[required: { -> true },
+        defaultValue: { -> ""}] as RequestParam]                                        | true
+      [[required: { -> true },
+        defaultValue: { -> null}] as RequestParam]                                      | true
+      [[required: { -> true },
+        defaultValue: { -> "default value"}] as RequestParam]                           | false
+      [[required: { -> false },
+        defaultValue: { -> ValueConstants.DEFAULT_NONE}] as RequestParam]               | false
+      [[required: { -> true }] as ApiParam,
+       [required: { -> false },
+      defaultValue: { -> ValueConstants.DEFAULT_NONE}] as RequestParam]                 | false
+      [[required: { -> false }] as ApiParam,
+       [required: { -> true },
+        defaultValue: { -> ValueConstants.DEFAULT_NONE}] as RequestParam]               | true
       [[required: { -> false }] as RequestBody]                                         | false
       [[required: { -> true }] as RequestBody]                                          | true
-      [[required: { -> false }] as ApiParam, [required: { -> true }] as RequestParam]   | true
+      [[required: { -> false }] as ApiParam,
+       [required: { -> true },
+        defaultValue: { -> ValueConstants.DEFAULT_NONE}] as RequestParam]               | true
       []                                                                                | false
       [null]                                                                            | false
   }
