Merge pull request #2548 from swagger-api/issue-2466-updated

ref #2466 - retain generic types for attributes of BeanParam (Updated)

Author: frantuma

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/DefaultParameterExtension.java

@@ -125,7 +125,7 @@ public List<Parameter> extractParameters(List<Annotation> annotations, Type type
      */
     private void handleAdditionalAnnotation(List<Parameter> parameters, Annotation annotation, 
         final Type type, Set<Type> typesToSkip) {
-        if (CLASS_BEAN_PARAM != null && CLASS_BEAN_PARAM.isAssignableFrom(annotation.getClass())) {
+        if (isBeanParametersAggregatorAnnotation(annotation)) {
             // Use Jackson's logic for processing Beans
             final BeanDescription beanDesc = mapper.getSerializationConfig().introspect(constructType(type));
             final List<BeanPropertyDefinition> properties = beanDesc.findProperties();
@@ -140,7 +140,7 @@ private void handleAdditionalAnnotation(List<Parameter> parameters, Annotation a
 
                 // Gather the field's details
                 if (field != null) {
-                    paramType = field.getRawType();
+                    paramType = field.getType();
 
                     for (final Annotation fieldAnnotation : field.annotations()) {
                         if (!paramAnnotations.contains(fieldAnnotation)) {
@@ -153,7 +153,8 @@ private void handleAdditionalAnnotation(List<Parameter> parameters, Annotation a
                 if (setter != null) {
                     // Do not set the param class/type from the setter if the values are already identified
                     if (paramType == null) {
-                        paramType = setter.getRawParameterTypes() != null ? setter.getRawParameterTypes()[0] : null;
+                    	// paramType will stay null if there is no parameter
+                        paramType = setter.getParameterType(0); 
                     }
 
                     for (final Annotation fieldAnnotation : setter.annotations()) {
@@ -167,7 +168,7 @@ private void handleAdditionalAnnotation(List<Parameter> parameters, Annotation a
                 if (getter != null) {
                     // Do not set the param class/type from the getter if the values are already identified
                     if (paramType == null) {
-                        paramType = getter.getRawReturnType();
+                        paramType = getter.getType();
                     }
 
                     for (final Annotation fieldAnnotation : getter.annotations()) {
@@ -194,6 +195,10 @@ private void handleAdditionalAnnotation(List<Parameter> parameters, Annotation a
             }
         }
     }
+    
+    protected boolean isBeanParametersAggregatorAnnotation(Annotation annotation) {
+        return CLASS_BEAN_PARAM != null && CLASS_BEAN_PARAM.isAssignableFrom(annotation.getClass());
+    }
 
     @Override
     protected boolean shouldIgnoreClass(Class<?> cls) {

modules/swagger-jaxrs/src/test/java/io/swagger/BeanParamTest.java

@@ -0,0 +1,82 @@
+package io.swagger;
+
+import java.lang.annotation.Annotation;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.Collections;
+import java.util.List;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+
+import org.testng.Assert;
+import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import io.swagger.annotations.Api;
+import io.swagger.jaxrs.DefaultParameterExtension;
+import io.swagger.jaxrs.Reader;
+import io.swagger.jaxrs.ext.SwaggerExtension;
+import io.swagger.jaxrs.ext.SwaggerExtensions;
+import io.swagger.models.ListOfStringsBeanParam;
+import io.swagger.models.Swagger;
+import io.swagger.models.parameters.Parameter;
+import io.swagger.models.parameters.QueryParameter;
+import io.swagger.models.properties.Property;
+import io.swagger.models.properties.StringProperty;
+
+public class BeanParamTest {
+
+    @Target({ ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD })
+    @Retention(RetentionPolicy.RUNTIME)
+    public @interface MyBeanParam {
+        // Remove this Annotation and use BeanParam directly with Swagger Core 2.0
+    }
+
+    @Api
+    @Path("/")
+    private static class MyBeanParamResource {
+        @GET
+        public String getWithBeanParam(@MyBeanParam ListOfStringsBeanParam listOfStringsBean) {
+            return "result";
+        }
+    }
+
+    private final SwaggerExtension myDefaultParameterExtension = new DefaultParameterExtension() {
+        @Override
+        protected boolean isBeanParametersAggregatorAnnotation(Annotation annotation) {
+            return annotation instanceof MyBeanParam;
+        }
+    };
+
+    private List<SwaggerExtension> originalExtensions;
+
+    @BeforeMethod
+    public void beforeMethod() {
+        originalExtensions = SwaggerExtensions.getExtensions();
+        SwaggerExtensions.setExtensions(Collections.singletonList(myDefaultParameterExtension));
+    }
+
+    @AfterMethod
+    public void afterMethod() {
+        SwaggerExtensions.setExtensions(originalExtensions);
+    }
+
+    @Test(description = "check array type of serialized BeanParam containing QueryParams") // tests issue #2466
+    public void shouldSerializeTypeParameter() {
+        Swagger swagger = new Reader(new Swagger()).read(MyBeanParamResource.class);
+        List<Parameter> getOperationParams = swagger.getPath("/").getGet().getParameters();
+        Assert.assertEquals(getOperationParams.size(), 1);
+        QueryParameter param = (QueryParameter) getOperationParams.get(0);
+        Assert.assertEquals(param.getName(), "listOfStrings");
+        Assert.assertEquals(param.getType(), "array");
+        // These are the important checks:
+        Property itemsProperty = param.getItems();
+        Assert.assertEquals(itemsProperty.getClass(), StringProperty.class);
+        Assert.assertEquals(itemsProperty.getType(), "string");
+    }
+
+}

modules/swagger-jaxrs/src/test/java/io/swagger/models/ListOfStringsBeanParam.java

@@ -0,0 +1,21 @@
+package io.swagger.models;
+
+import java.util.List;
+
+import javax.ws.rs.QueryParam;
+
+import io.swagger.annotations.ApiModel;
+
+@ApiModel
+public class ListOfStringsBeanParam {
+    @QueryParam(value = "listOfStrings")
+    private List<String> list;
+
+    public List<String> getList() {
+        return list;
+    }
+
+    public void setList(List<String> list) {
+        this.list = list;
+    }
+}

modules/swagger-jersey2-jaxrs/src/test/java/io/swagger/BeanParamTest.java

@@ -0,0 +1,44 @@
+package io.swagger;
+
+import io.swagger.annotations.Api;
+import io.swagger.jaxrs.Reader;
+import io.swagger.models.ListOfStringsBeanParam;
+import io.swagger.models.Swagger;
+import io.swagger.models.parameters.Parameter;
+import io.swagger.models.parameters.QueryParameter;
+import io.swagger.models.properties.Property;
+import io.swagger.models.properties.StringProperty;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+import javax.ws.rs.BeanParam;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import java.util.List;
+
+public class BeanParamTest {
+
+    @Api
+    @Path("/")
+    private static class MyBeanParamResource {
+        @GET
+        public String getWithBeanParam(@BeanParam ListOfStringsBeanParam listOfStringsBean) {
+            return "result";
+        }
+    }
+
+    @Test(description = "check array type of serialized BeanParam containing QueryParams") // tests issue #2466
+    public void shouldSerializeTypeParameter() {
+        Swagger swagger = new Reader(new Swagger()).read(MyBeanParamResource.class);
+        List<Parameter> getOperationParams = swagger.getPath("/").getGet().getParameters();
+        Assert.assertEquals(getOperationParams.size(), 1);
+        QueryParameter param = (QueryParameter) getOperationParams.get(0);
+        Assert.assertEquals(param.getName(), "listOfStrings");
+        Assert.assertEquals(param.getType(), "array");
+        // These are the important checks:
+        Property itemsProperty = param.getItems();
+        Assert.assertEquals(itemsProperty.getClass(), StringProperty.class);
+        Assert.assertEquals(itemsProperty.getType(), "string");
+    }
+
+}

modules/swagger-jersey2-jaxrs/src/test/java/io/swagger/models/ListOfStringsBeanParam.java

@@ -0,0 +1,20 @@
+package io.swagger.models;
+
+import io.swagger.annotations.ApiModel;
+
+import javax.ws.rs.QueryParam;
+import java.util.List;
+
+@ApiModel
+public class ListOfStringsBeanParam {
+    @QueryParam(value = "listOfStrings")
+    private List<String> list;
+
+    public List<String> getList() {
+        return list;
+    }
+
+    public void setList(List<String> list) {
+        this.list = list;
+    }
+}