openapi-processor/openapi-processor-spring#140, finish global additional parameters

Author: hauner

src/main/kotlin/io/openapiprocessor/core/converter/ApiConverter.kt

@@ -114,12 +114,26 @@ class  ApiConverter(
             ep.parameters.add (createParameter (ep, parameter, dataTypes, resolver))
         }
 
-        val addMappings = mappingFinder.findEndpointAddParameterTypeMappings (ep.path, ep.method)
+        val addMappings = getAdditionalParameter (ep)
         addMappings.forEach {
             ep.parameters.add (createAdditionalParameter (it, dataTypes, resolver))
         }
     }
 
+    private fun getAdditionalParameter(ep: Endpoint): List<AddParameterTypeMapping> {
+        // check endpoint parameter mappings
+        val epMatch = mappingFinder.findEndpointAddParameterTypeMappings (ep.path, ep.method)
+        if (epMatch.isNotEmpty())
+            return epMatch
+
+        // check global parameter mappings
+        val paramMatch = mappingFinder.findAddParameterTypeMappings()
+        if (paramMatch.isNotEmpty())
+            return paramMatch
+
+        return emptyList()
+    }
+
     private fun collectRequestBody(requestBody: RequestBody?, ep: Endpoint, dataTypes: DataTypes, resolver: RefResolver) {
         if (requestBody == null) {
             return

src/main/kotlin/io/openapiprocessor/core/converter/mapping/MappingFinder.kt

@@ -76,11 +76,27 @@ class MappingFinder(private val typeMappings: List<Mapping> = emptyList()) {
         return getTypeMapping(filterMappings(TypeMatcher(info), typeMappings))
     }
 
+    /**
+     * find a matching (global) add parameter type mapping.
+     *
+     * @return the matching mappings or an empty list.
+     * @throws AmbiguousTypeMappingException if there is more than one match.
+     */
+    fun findAddParameterTypeMappings(): List<AddParameterTypeMapping>  {
+        val matches = typeMappings
+            .filterIsInstance(AddParameterTypeMapping::class.java)
+
+        if (matches.isNotEmpty())
+            return matches
+
+        return emptyList()
+    }
+
     /**
      * find all (endpoint) add parameter type mappings for the given schema info.
      *
      * @param path the endpoint path
-     * @return the matching mapping or null if there is no match.
+     * @return the matching mappings or an empty list.
      * @throws AmbiguousTypeMappingException if there is more than one match.
      */
     fun findEndpointAddParameterTypeMappings(path: String, method: HttpMethod): List<AddParameterTypeMapping> {

src/testInt/kotlin/io/openapiprocessor/core/ProcessorPendingSpec.kt

@@ -19,7 +19,7 @@ import io.openapiprocessor.test.TestSetRunner
 class ProcessorPendingSpec: StringSpec({
 
     for (testSet in sources()) {
-        "native - $testSet".config(enabled = true) {
+        "native - $testSet".config(enabled = false) {
             val folder = tempdir()
 
             val support = FileSupport(
@@ -37,8 +37,8 @@ private fun sources(): Collection<TestSet> {
     return listOf(
 //        testSet("params-additional-new", ParserType.SWAGGER, API_30),
 //        testSet("params-additional-new", ParserType.OPENAPI4J, API_30),
-        testSet("params-additional", INTERNAL, API_30),
-        testSet("params-additional", INTERNAL, API_31)
+//        testSet("params-additional-global", INTERNAL, API_30),
+//        testSet("params-additional-global", INTERNAL, API_31)
     )
 }
 

src/testInt/kotlin/io/openapiprocessor/core/ProcessorTestSets.kt

@@ -25,6 +25,7 @@ val ALL_30: List<TestSet> = listOf(
     TestSet("object-read-write-properties", API_30),
     TestSet("object-without-properties", API_30),
     TestSet("params-additional", API_30),
+    TestSet("params-additional-global", API_30),
     TestSet("params-complex-data-types", API_30), // framework specific
     TestSet("params-endpoint", API_30),
     TestSet("params-enum", API_30),
@@ -80,6 +81,7 @@ val ALL_31: List<TestSet> = listOf(
     TestSet("object-read-write-properties", API_31),
     TestSet("object-without-properties", API_31),
     TestSet("params-additional", API_31),
+    TestSet("params-additional-global", API_31),
     TestSet("params-complex-data-types", API_31), // framework specific
     TestSet("params-endpoint", API_31),
     TestSet("params-enum", API_31),

src/testInt/resources/tests/params-additional-global/generated.yaml

@@ -0,0 +1,2 @@
+items:
+  - generated/api/Api.java

src/testInt/resources/tests/params-additional-global/generated/api/Api.java

@@ -0,0 +1,17 @@
+/*
+ * This class is auto generated by https://github.com/hauner/openapi-processor-core.
+ * TEST ONLY.
+ */
+
+package generated.api;
+
+import annotation.Mapping;
+import annotation.Parameter;
+import javax.servlet.http.HttpServletRequest;
+
+public interface Api {
+
+    @Mapping("/foo")
+    void getFoo(@Parameter String foo, @Parameter HttpServletRequest request);
+
+}

src/testInt/resources/tests/params-additional-global/inputs.yaml

@@ -0,0 +1,5 @@
+items:
+  - inputs/openapi30.yaml
+  - inputs/openapi31.yaml
+  - inputs/foo.yaml
+  - inputs/mapping.yaml

src/testInt/resources/tests/params-additional-global/inputs/foo.yaml

@@ -0,0 +1,11 @@
+get:
+  parameters:
+    - name: foo
+      description: query, required
+      in: query
+      required: true
+      schema:
+        type: string
+  responses:
+    '204':
+      description: empty

src/testInt/resources/tests/params-additional-global/inputs/mapping.yaml

@@ -0,0 +1,9 @@
+openapi-processor-mapping: v2
+
+options:
+  package-name: generated
+
+map:
+
+  parameters:
+   - add: request => javax.servlet.http.HttpServletRequest

src/testInt/resources/tests/params-additional-global/inputs/openapi30.yaml

@@ -0,0 +1,8 @@
+openapi: 3.0.2
+info:
+  title: test additional global parameters
+  version: 1.0.0
+
+paths:
+  /foo:
+    $ref: 'foo.yaml'

src/testInt/resources/tests/params-additional-global/inputs/openapi31.yaml

@@ -0,0 +1,8 @@
+openapi: 3.1.0
+info:
+  title: test additional global parameters
+  version: 1.0.0
+
+paths:
+  /foo:
+    $ref: 'foo.yaml'