write additional annotation of an additional parameter

Author: hauner

src/main/groovy/com/github/hauner/openapi/core/model/datatypes/AnnotationDataType.groovy

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2020 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi.core.model.datatypes
+
+/**
+ * additional annotation type.
+ *
+ * @author Martin Hauner
+ */
+class AnnotationDataType implements DataType {
+
+    protected String type
+    String pkg = 'unknown'
+    String parameters
+
+    @Override
+    String getName () {
+        "@$type"
+    }
+
+    @Override
+    String getPackageName () {
+        pkg
+    }
+
+    String getParameters () {
+        parameters ?: ""
+    }
+
+    @Override
+    Set<String> getImports () {
+        [[packageName, type].join ('.')]
+    }
+
+    @Override
+    Set<String> getReferencedImports () {
+        []
+    }
+
+}

src/main/groovy/com/github/hauner/openapi/core/model/parameters/AdditionalParameter.groovy

@@ -16,6 +16,8 @@
 
 package com.github.hauner.openapi.core.model.parameters
 
+import com.github.hauner.openapi.core.model.datatypes.AnnotationDataType
+
 /**
  * default implementation of am additional parameter.
  *
@@ -25,8 +27,14 @@ package com.github.hauner.openapi.core.model.parameters
  */
 class AdditionalParameter extends ParameterBase {
 
+    AnnotationDataType annotationDataType
+
     boolean withAnnotation () {
         false
     }
 
+    boolean hasAdditionalAnnotation () {
+        annotationDataType != null
+    }
+
 }

src/main/groovy/com/github/hauner/openapi/core/writer/java/MethodWriter.groovy

@@ -16,6 +16,7 @@
 
 package com.github.hauner.openapi.core.writer.java
 
+import com.github.hauner.openapi.core.model.parameters.AdditionalParameter
 import com.github.hauner.openapi.core.model.parameters.Parameter
 import com.github.hauner.openapi.core.writer.java.MappingAnnotationWriter as CoreMappingAnnotationWriter
 import com.github.hauner.openapi.core.writer.java.ParameterAnnotationWriter as CoreParameterAnnotationWriter
@@ -108,7 +109,13 @@ class MethodWriter {
         if (parameter.deprecated) {
             annotation.write ("@Deprecated ")
         }
+
         parameterAnnotationWriter.write (annotation, parameter)
+
+        if (parameter instanceof AdditionalParameter && parameter.hasAdditionalAnnotation ()) {
+            annotation.write (" ${parameter.annotationDataType.name}${parameter.annotationDataType.parameters}")
+        }
+
         annotation.toString ()
     }
 

src/test/groovy/com/github/hauner/openapi/core/writer/java/MethodWriterSpec.groovy

@@ -17,6 +17,7 @@
 package com.github.hauner.openapi.core.writer.java
 
 import com.github.hauner.openapi.core.converter.ApiOptions
+import com.github.hauner.openapi.core.model.datatypes.AnnotationDataType
 import com.github.hauner.openapi.core.model.datatypes.NoneDataType
 import com.github.hauner.openapi.core.model.datatypes.ResultDataType
 import com.github.hauner.openapi.core.model.parameters.Parameter
@@ -192,7 +193,7 @@ class MethodWriterSpec extends Specification {
 """
     }
 
-    void "does not write parameter annotation if empty" () {
+    void "writes no parameter annotation if the annotation writer skips it" () {
         def stubWriter = Stub (ParameterAnnotationWriter) {}
 
         writer.parameterAnnotationWriter = stubWriter
@@ -213,6 +214,30 @@ class MethodWriterSpec extends Specification {
 """
     }
 
+    void "writes additional parameter annotation" () {
+        def endpoint = endpoint('/foo') {
+            parameters {
+                add {
+                    name ('foo')
+                    type (new StringDataType())
+                    annotation (new AnnotationDataType (pkg: 'oap', type: 'Foo', parameters: '()'))
+                }
+            }
+            responses ('204') {
+                empty ()
+            }
+        }
+
+        when:
+        writer.write (target, endpoint, endpoint.endpointResponses.first ())
+
+        then:
+        target.toString () == """\
+    @CoreMapping
+    void getFoo(@Parameter @Foo() String foo);
+"""
+    }
+
     void "writes method name from path with valid java identifiers" () {
         def endpoint = createEndpoint (path: '/f_o-ooo/b_a-rrr', method: HttpMethod.GET, responses: [
             '204': [new EmptyResponse ()]

src/test/groovy/io/openapiprocessor/core/model/Builder.groovy

@@ -21,11 +21,14 @@ import com.github.hauner.openapi.core.model.HttpMethod
 import com.github.hauner.openapi.core.model.Interface
 import com.github.hauner.openapi.core.model.RequestBody
 import com.github.hauner.openapi.core.model.Response
+import com.github.hauner.openapi.core.model.datatypes.AnnotationDataType
 import com.github.hauner.openapi.core.model.datatypes.DataType
 import com.github.hauner.openapi.core.model.datatypes.NoneDataType
 import com.github.hauner.openapi.core.model.datatypes.ObjectDataType
+import com.github.hauner.openapi.core.model.parameters.AdditionalParameter
 import com.github.hauner.openapi.core.model.parameters.MultipartParameter
 import com.github.hauner.openapi.core.model.parameters.Parameter
+import com.github.hauner.openapi.core.model.parameters.QueryParameter
 
 class Builder {
 
@@ -90,6 +93,15 @@ class EndpointBuilder {
         parameters.addAll (builder.buildParameters ())
     }
 
+    void parameters (@DelegatesTo(strategy = Closure.DELEGATE_ONLY, value = ParametersBuilder) Closure init) {
+        def builder = new ParametersBuilder()
+        def code = init.rehydrate (builder, this, this)
+        code.resolveStrategy = Closure.DELEGATE_ONLY
+        code()
+        def params = builder.build ()
+        parameters.addAll (params)
+    }
+
     void responses (String httpStatus, @DelegatesTo(strategy = Closure.DELEGATE_ONLY, value = ResponsesBuilder) Closure init) {
         def builder = new ResponsesBuilder()
         def code = init.rehydrate (builder, this, this)
@@ -180,6 +192,74 @@ class BodyBuilder {
 }
 
 
+class ParametersBuilder {
+    private List<Parameter> parameters = []
+
+    void query (@DelegatesTo(strategy = Closure.DELEGATE_ONLY, value = QueryParameterBuilder) Closure init) {
+        def builder = new QueryParameterBuilder()
+        def code = init.rehydrate (builder, this, this)
+        code.resolveStrategy = Closure.DELEGATE_ONLY
+        code()
+        def parameter = builder.build ()
+        parameters.add (parameter)
+    }
+
+    void add (@DelegatesTo(strategy = Closure.DELEGATE_ONLY, value = QueryParameterBuilder) Closure init) {
+        def builder = new AddParameterBuilder()
+        def code = init.rehydrate (builder, this, this)
+        code.resolveStrategy = Closure.DELEGATE_ONLY
+        code()
+        def parameter = builder.build ()
+        parameters.add (parameter)
+    }
+
+    List<Parameter> build () {
+        parameters
+    }
+
+}
+
+class QueryParameterBuilder {
+    private String name
+    private DataType type
+
+    void name (String name) {
+        this.name = name
+    }
+
+    void type (DataType dataType) {
+        this.type = dataType
+    }
+
+    QueryParameter build () {
+        new QueryParameter(name: name, dataType: dataType)
+    }
+
+}
+
+class AddParameterBuilder {
+    private String name
+    private DataType type
+    private AnnotationDataType annotationType
+
+    void name (String name) {
+        this.name = name
+    }
+
+    void type (DataType dataType) {
+        this.type = dataType
+    }
+
+    void annotation (AnnotationDataType dataType) {
+        annotationType = dataType
+    }
+
+    AdditionalParameter build () {
+        new AdditionalParameter (name: name, dataType: type, annotationDataType: annotationType)
+    }
+
+}
+
 
 class ResponsesBuilder {
     private List<Response> responses = []