object parameters should not have @QueryParam annotation

Author: hauner

src/main/groovy/com/github/hauner/openapi/spring/model/parameters/QueryParameter.groovy

@@ -18,6 +18,7 @@ package com.github.hauner.openapi.spring.model.parameters
 
 import com.github.hauner.openapi.spring.model.datatypes.DataType
 import com.github.hauner.openapi.spring.model.datatypes.MapDataType
+import com.github.hauner.openapi.spring.model.datatypes.MappedDataType
 import com.github.hauner.openapi.spring.model.datatypes.ObjectDataType
 
 /**
@@ -56,6 +57,19 @@ class QueryParameter {
     }
 
     /**
+     * Create annotation? If the query parameter is mapped to a pojo object it should not have a
+     * {@code @RequestParam} annotation.
+     */
+    boolean withAnnotation () {
+        ! (
+            dataType instanceof ObjectDataType
+         || dataType instanceof MappedDataType
+        )
+    }
+
+    /**
+     * todo this is not right.
+     *
      * Create annotation with parameters? If the query parameter is mapped to a pojo object it
      * should not have any parameters.
      *

src/main/groovy/com/github/hauner/openapi/spring/writer/InterfaceWriter.groovy

@@ -57,7 +57,9 @@ class InterfaceWriter {
             imports.add (ep.method.classNameWithPackage)
 
             ep.parameters.each { p ->
-                imports.add (p.annotationWithPackage)
+                if (p.withAnnotation()) {
+                    imports.add (p.annotationWithPackage)
+                }
             }
 
             if (!ep.response.empty) {

src/main/groovy/com/github/hauner/openapi/spring/writer/MethodWriter.groovy

@@ -77,7 +77,13 @@ class MethodWriter {
 
     private String createParameter (Endpoint endpoint) {
         def ps = endpoint.parameters.collect {
-            "${createParameterAnnotation (it)} ${it.dataType.name} ${it.name}"
+
+            if (it.withAnnotation ()) {
+                "${createParameterAnnotation (it)} ${it.dataType.name} ${it.name}"
+            } else {
+                "${it.dataType.name} ${it.name}"
+            }
+
         }
 
         ps.join (', ')

src/test/groovy/com/github/hauner/openapi/spring/writer/InterfaceWriterSpec.groovy

@@ -20,6 +20,7 @@ import com.github.hauner.openapi.spring.model.Endpoint
 import com.github.hauner.openapi.spring.model.HttpMethod
 import com.github.hauner.openapi.spring.model.Interface
 import com.github.hauner.openapi.spring.model.Response
+import com.github.hauner.openapi.spring.model.datatypes.NoneDataType
 import com.github.hauner.openapi.spring.model.datatypes.ObjectDataType
 import com.github.hauner.openapi.spring.model.datatypes.StringDataType
 import com.github.hauner.openapi.spring.model.parameters.QueryParameter
@@ -134,6 +135,30 @@ import org.springframework.web.bind.annotation.RequestParam;
 """)
     }
 
+    void "does not write @RequestParam annotation import of request parameter that does not want the annotation" () {
+        def endpoint = new Endpoint (path: '/foo', method: HttpMethod.GET, responses: [
+            new Response (contentType: 'application/json', responseType: new NoneDataType())
+        ], parameters: [
+            new QueryParameter(name: 'foo', required: false, dataType: new ObjectDataType (
+                type: 'Foo', properties: [
+                    foo1: new StringDataType (),
+                    foo2: new StringDataType ()
+                ]
+            ))
+        ])
+
+        def apiItf = new Interface (name: 'name', endpoints: [endpoint])
+
+        when:
+        writer.write (target, apiItf)
+
+        then:
+        def result = extractImports (target.toString ())
+        ! result.contains("""\
+import org.springframework.web.bind.annotation.RequestParam;
+""")
+    }
+
     void "writes model import"() {
         def pkg = 'model.package'
         def type = 'Model'

src/test/groovy/com/github/hauner/openapi/spring/writer/MethodWriterSpec.groovy

@@ -179,7 +179,7 @@ class MethodWriterSpec extends Specification {
 """
     }
 
-    void "writes object query parameter" () {
+    void "writes object query parameter without @RequestParam annotation" () {
         def endpoint = new Endpoint (path: '/foo', method: HttpMethod.GET, responses: [
             new Response (contentType: 'application/json', responseType: new NoneDataType())
         ], parameters: [
@@ -197,7 +197,7 @@ class MethodWriterSpec extends Specification {
         then:
         target.toString () == """\
     @GetMapping(path = "${endpoint.path}")
-    ResponseEntity<void> getFoo(@RequestParam Foo foo);
+    ResponseEntity<void> getFoo(Foo foo);
 """
     }