Add support for Jersey2 BeanParam.

shuz · Apr 16, 2014 · 5213b4f · shuz · Apr 16, 2014 · 5213b4f
1 parent d32b697
commit 5213b4f
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 29 deletions.
diff --git a/modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/JaxrsApiReader.scala b/modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/JaxrsApiReader.scala
@@ -24,7 +24,7 @@ trait JaxrsApiReader extends ClassReader with ClassReaderUtils {
   val GenericTypeMapper = "([a-zA-Z\\.]*)<([a-zA-Z0-9\\.\\,\\s]*)>".r
 
   // decorates a Parameter based on annotations, returns None if param should be ignored
-  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): Option[Parameter]
+  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): List[Parameter]
 
   // decorates an Operation
   def processOperation(endpoint: String, operation: Operation, method: Method, apiOperation: ApiOperation) : Operation = {
@@ -146,7 +146,7 @@ trait JaxrsApiReader extends ClassReader with ClassReaderUtils {
         param.name = TYPE_BODY
         param.paramType = TYPE_BODY
 
-        Some(param.asParameter)
+        List(param.asParameter)
       }
     }).flatten.toList
 
@@ -260,24 +260,7 @@ trait JaxrsApiReader extends ClassReader with ClassReaderUtils {
         case _ => None
       }
       // look for method-level annotated properties
-      val parentParams: List[Parameter] = (for(field <- getAllFields(cls)) 
-        yield {
-          // only process fields with @ApiParam, @QueryParam, @HeaderParam, @PathParam
-          if(field.getAnnotation(classOf[QueryParam]) != null || field.getAnnotation(classOf[HeaderParam]) != null ||
-            field.getAnnotation(classOf[HeaderParam]) != null || field.getAnnotation(classOf[PathParam]) != null ||
-            field.getAnnotation(classOf[ApiParam]) != null) { 
-            val param = new MutableParameter
-            param.dataType = field.getType.getName
-            Option (field.getAnnotation(classOf[ApiParam])) match {
-              case Some(annotation) => toAllowableValues(annotation.allowableValues)
-              case _ =>
-            }
-            val annotations = field.getAnnotations
-            processParamAnnotations(param, annotations)
-          }
-          else None
-        }
-      ).flatten.toList
+      val parentParams: List[Parameter] = getAllParamsFromFields(cls)
 
       for(method <- cls.getMethods) {
         val returnType = findSubresourceType(method)
@@ -345,6 +328,25 @@ trait JaxrsApiReader extends ClassReader with ClassReaderUtils {
     }   
     return fields;
   }
+
+  def getAllParamsFromFields(cls: Class[_]): List[Parameter] = {
+    (for(field <- getAllFields(cls)) yield {
+      // only process fields with @ApiParam, @QueryParam, @HeaderParam, @PathParam
+      if(field.getAnnotation(classOf[QueryParam]) != null || field.getAnnotation(classOf[HeaderParam]) != null ||
+        field.getAnnotation(classOf[HeaderParam]) != null || field.getAnnotation(classOf[PathParam]) != null ||
+        field.getAnnotation(classOf[ApiParam]) != null) {
+        val param = new MutableParameter
+        param.dataType = field.getType.getName
+        Option (field.getAnnotation(classOf[ApiParam])) match {
+          case Some(annotation) => toAllowableValues(annotation.allowableValues)
+          case _ =>
+        }
+        val annotations = field.getAnnotations
+        processParamAnnotations(param, annotations)
+      }
+      else List.empty
+    }).flatten.toList
+  }
 
   def pathFromMethod(method: Method): String = {
     val path = method.getAnnotation(classOf[javax.ws.rs.Path])

diff --git a/...es/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/reader/DefaultJaxrsReader.scala b/...es/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/reader/DefaultJaxrsReader.scala
@@ -13,7 +13,7 @@ import javax.ws.rs.core.Context
 
 class DefaultJaxrsApiReader extends JaxrsApiReader {
   // decorates a Parameter based on annotations, returns None if param should be ignored
-  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): Option[Parameter] = {
+  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): List[Parameter] = {
     var shouldIgnore = false
     for (pa <- paramAnnotations) {
       pa match {
@@ -55,9 +55,9 @@ class DefaultJaxrsApiReader extends JaxrsApiReader {
         mutable.paramType = TYPE_BODY
         mutable.name = TYPE_BODY
       }
-      Some(mutable.asParameter)
+      List(mutable.asParameter)
     }
-    else None
+    else List.empty
   }
 
   def findSubresourceType(method: Method): Class[_] = {

diff --git a/modules/swagger-jersey-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala b/modules/swagger-jersey-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala
@@ -40,7 +40,7 @@ import com.sun.jersey.api.core.InjectParam
 class JerseyApiReader extends JaxrsApiReader {
   private val LOGGER = LoggerFactory.getLogger(classOf[JerseyApiReader])
 
-  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): Option[Parameter] = {
+  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): List[Parameter] = {
     var shouldIgnore = false
     for (pa <- paramAnnotations) {
       pa match {
@@ -98,9 +98,9 @@ class JerseyApiReader extends JaxrsApiReader {
         mutable.paramType = TYPE_BODY
         mutable.name = TYPE_BODY
       }
-      Some(mutable.asParameter)
+      List(mutable.asParameter)
     }
-    else None
+    else List()
   }
 
   def findSubresourceType(method: Method): Class[_] = {

diff --git a/...les/swagger-jersey2-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala b/...les/swagger-jersey2-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala
@@ -39,7 +39,7 @@ import org.glassfish.jersey.media.multipart.FormDataParam
 class JerseyApiReader extends JaxrsApiReader {
   private val LOGGER = LoggerFactory.getLogger(classOf[JerseyApiReader])
 
-  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): Option[Parameter] = {
+  def processParamAnnotations(mutable: MutableParameter, paramAnnotations: Array[Annotation]): List[Parameter] = {
     var shouldIgnore = false
     for (pa <- paramAnnotations) {
       pa match {
@@ -84,6 +84,10 @@ class JerseyApiReader extends JaxrsApiReader {
             }
           }
         }
+        case e: BeanParam => {
+          val cls = SwaggerContext.loadClass(mutable.dataType)
+          return getAllParamsFromFields(cls.getRawClass)
+        }
         case e: Context => shouldIgnore = true
         case _ =>
       }
@@ -93,9 +97,9 @@ class JerseyApiReader extends JaxrsApiReader {
         mutable.paramType = TYPE_BODY
         mutable.name = TYPE_BODY
       }
-      Some(mutable.asParameter)
+      List(mutable.asParameter)
     }
-    else None
+    else List.empty
   }
   def findSubresourceType(method: Method): Class[_] = {
     method.getGenericReturnType match {