added fix, test for #937

Author: fehguy

modules/swagger-jaxrs/src/main/java/com/wordnik/swagger/jaxrs/DefaultParameterExtension.java

@@ -26,19 +26,26 @@ public class DefaultParameterExtension extends AbstractSwaggerExtension implemen
   Logger LOGGER = LoggerFactory.getLogger(DefaultParameterExtension.class);
 
   public List<Parameter> extractParameters(Annotation[] annotations, Class<?> cls, boolean isArray, Set<Class<?>> classesToSkip, Iterator<SwaggerExtension> chain) {
-    String defaultValue = null;
+    String defaultValue = "";
 
     if(this.shouldIgnoreClass(cls))
       return new ArrayList<Parameter>();
 
     List<Parameter> parameters = new ArrayList<Parameter>();
     Parameter parameter = null;
     for(Annotation annotation : annotations) {
+      if(annotation instanceof DefaultValue) {
+        DefaultValue defaultValueAnnotation = (DefaultValue) annotation;
+        defaultValue = defaultValueAnnotation.value();
+      }
       if(annotation instanceof QueryParam) {
         QueryParam param = (QueryParam) annotation;
         QueryParameter qp = new QueryParameter()
           .name(param.value());
-        qp.setDefaultValue(defaultValue);
+
+        if(!defaultValue.isEmpty()) {
+          qp.setDefaultValue(defaultValue);
+        }
         Property schema = ModelConverters.getInstance().readAsProperty(cls);
         if(schema != null)
           qp.setProperty(schema);
@@ -48,7 +55,8 @@ else if(annotation instanceof PathParam) {
         PathParam param = (PathParam) annotation;
         PathParameter pp = new PathParameter()
           .name(param.value());
-        pp.setDefaultValue(defaultValue);
+        if(!defaultValue.isEmpty())
+          pp.setDefaultValue(defaultValue);
         Property schema = ModelConverters.getInstance().readAsProperty(cls);
         if(schema != null)
           pp.setProperty(schema);
@@ -68,7 +76,8 @@ else if(annotation instanceof CookieParam) {
         CookieParam param = (CookieParam) annotation;
         CookieParameter cp = new CookieParameter()
           .name(param.value());
-        cp.setDefaultValue(defaultValue);
+        if(!defaultValue.isEmpty())
+          cp.setDefaultValue(defaultValue);
         Property schema = ModelConverters.getInstance().readAsProperty(cls);
         if(schema != null)
           cp.setProperty(schema);
@@ -78,17 +87,13 @@ else if(annotation instanceof FormParam) {
         FormParam param = (FormParam) annotation;
         FormParameter fp = new FormParameter()
           .name(param.value());
-        fp.setDefaultValue(defaultValue);
+        if(!defaultValue.isEmpty())
+          fp.setDefaultValue(defaultValue);
         Property schema = ModelConverters.getInstance().readAsProperty(cls);
         if(schema != null)
           fp.setProperty(schema);
         parameter = fp;
       }
-      else if(annotation instanceof DefaultValue) {
-        DefaultValue defaultValueAnnotation = (DefaultValue) annotation;
-        // TODO: not supported yet
-        defaultValue = defaultValueAnnotation.value();
-      }
     }
     if(parameter != null) {
       parameters.add(parameter);

modules/swagger-jaxrs/src/main/java/com/wordnik/swagger/jaxrs/ParameterProcessor.java

@@ -30,48 +30,62 @@ public static Parameter applyAnnotations(Swagger swagger, Parameter parameter, C
       if(annotation instanceof ApiParam) {
         ApiParam param = (ApiParam) annotation;
         if(parameter != null) {
-          if(!"".equals(param.defaultValue())){
+          if(!param.defaultValue().isEmpty()){
             defaultValue = param.defaultValue();
           }
 
-          // parameter.required(param.required());
+          if(param.required() == true) {
+            System.out.println(param.required());
+            parameter.setRequired(param.required());
+          }
+
           if(param.name() != null && !"".equals(param.name()))
             parameter.setName(param.name());
           parameter.setDescription(param.value());
           parameter.setAccess(param.access());
           allowMultiple = param.allowMultiple() || isArray;
-          if(allowMultiple == true) {
-            if(parameter instanceof PathParameter) {
-              PathParameter p = (PathParameter) parameter;
+          if(parameter instanceof PathParameter) {
+            PathParameter p = (PathParameter) parameter;
+            if(defaultValue != null)
+              p.setDefaultValue(defaultValue);
+            if(allowMultiple == true) {
               Property items = PropertyBuilder.build(p.getType(), p.getFormat(), null);
               p.items(items)
                 .array(true)
                 .collectionFormat("multi");
-              p.setDefaultValue(defaultValue);
             }
-            else if(parameter instanceof QueryParameter) {
-              QueryParameter p = (QueryParameter) parameter;
+          }
+          else if(parameter instanceof QueryParameter) {
+            QueryParameter p = (QueryParameter) parameter;
+            if(defaultValue != null)
+              p.setDefaultValue(defaultValue);
+            if(allowMultiple == true) {
               Property items = PropertyBuilder.build(p.getType(), p.getFormat(), null);
               p.items(items)
                 .array(true)
                 .collectionFormat("multi");
-              p.setDefaultValue(defaultValue);
             }
-            else if(parameter instanceof HeaderParameter) {
-              HeaderParameter p = (HeaderParameter) parameter;
+          }
+          else if(parameter instanceof HeaderParameter) {
+            HeaderParameter p = (HeaderParameter) parameter;
+            if(defaultValue != null)
+              p.setDefaultValue(defaultValue);
+            if(allowMultiple == true) {
               Property items = PropertyBuilder.build(p.getType(), p.getFormat(), null);
               p.items(items)
                 .array(true)
                 .collectionFormat("multi");
-              p.setDefaultValue(defaultValue);
             }
-            else if(parameter instanceof CookieParameter) {
-              CookieParameter p = (CookieParameter) parameter;
+          }
+          else if(parameter instanceof CookieParameter) {
+            CookieParameter p = (CookieParameter) parameter;
+            if(defaultValue != null)
+              p.setDefaultValue(defaultValue);
+            if(allowMultiple == true) {
               Property items = PropertyBuilder.build(p.getType(), p.getFormat(), null);
               p.items(items)
                 .array(true)
                 .collectionFormat("multi");
-              p.setDefaultValue(defaultValue);
             }
           }
           allowableValues = param.allowableValues();

modules/swagger-jaxrs/src/test/scala/SimpleScannerTest.scala

@@ -144,12 +144,20 @@ class SimpleScannerTest extends FlatSpec with Matchers {
     val swagger = new Reader(new Swagger()).read(classOf[HiddenResource])
     val get = swagger.getPaths() should be (null)
   }
-}
 
-@RunWith(classOf[JUnitRunner])
-class SimpleScannerTest2 extends FlatSpec with Matchers {
   it should "correctly model an empty model per 499" in {
     val swagger = new Reader(new Swagger()).read(classOf[ResourceWithEmptyModel])
     Json.prettyPrint(swagger)
   }
 }
+
+@RunWith(classOf[JUnitRunner])
+class SimpleScannerTest2 extends FlatSpec with Matchers {
+  it should "scan defaultValue and required per #937" in {
+    val swagger = new Reader(new Swagger()).read(classOf[Resource937])
+    val get = swagger.getPaths().get("/external/info").getGet()
+    val param = get.getParameters().get(0).asInstanceOf[QueryParameter]
+    param.getRequired should be (false)
+    param.getDefaultValue should be ("dogs")
+  }
+}

modules/swagger-jaxrs/src/test/scala/resources/Resource937.java

@@ -0,0 +1,18 @@
+package resources;
+
+import com.wordnik.swagger.annotations.*;
+
+import javax.ws.rs.*;
+import javax.ws.rs.core.Response;
+
+import java.util.*;
+
+@Api("/external/info/")
+@Path("external/info/")
+public class Resource937 {
+  @ApiOperation(value="test")
+  @GET
+  public void getTest(@ApiParam(required=false, defaultValue = "dogs") @DefaultValue("cats") @QueryParam("isRequired") Boolean isRequired) {
+    return;
+  }
+}