Merge pull request #23 from openapi-processor/ref-parameter

resolves #23

Author: hauner

src/main/kotlin/io/openapiprocessor/core/parser/openapi4j/OpenApi.kt

@@ -28,18 +28,22 @@ import org.openapi4j.parser.model.v3.Path as O4jPath
  *
  * @author Martin Hauner
  */
-class OpenApi(private val api: O4jOpenApi, private val validations: ValidationResults): ParserOpenApi {
+class OpenApi(
+    private val api: O4jOpenApi,
+    private val validations: ValidationResults,
+): ParserOpenApi {
+    private val refResolver: RefResolverNative = RefResolverNative(api)
 
     override fun getPaths(): Map<String, ParserPath> {
         val paths = linkedMapOf<String, ParserPath>()
 
         api.paths.forEach { (name: String, value: O4jPath) ->
             var path = value
-            if (isRef(value)) {
-                path = resolve (path)
+            if (path.isRef) {
+                path = refResolver.resolve(path)
             }
 
-            paths[name] = Path(name, path)
+            paths[name] = Path(name, path, refResolver)
         }
 
         return paths
@@ -50,12 +54,4 @@ class OpenApi(private val api: O4jOpenApi, private val validations: ValidationRe
     override fun printWarnings() {
     }
 
-    private fun resolve(path: O4jPath): O4jPath {
-        return path.getReference (api.context).getMappedContent (O4jPath::class.java)
-    }
-
-    private fun isRef(path: O4jPath): Boolean {
-        return path.ref != null
-    }
-
 }

src/main/kotlin/io/openapiprocessor/core/parser/openapi4j/Operation.kt

@@ -30,7 +30,11 @@ import org.openapi4j.parser.model.v3.Response as O4jResponse
  *
  * @author Martin Hauner
  */
-class Operation(private val method: HttpMethod, private val operation: O4jOperation): ParserOperation {
+class Operation(
+    private val method: HttpMethod,
+    private val operation: O4jOperation,
+    private val refResolver: RefResolverNative
+): ParserOperation {
 
     override fun getMethod(): HttpMethod = method
 
@@ -42,7 +46,12 @@ class Operation(private val method: HttpMethod, private val operation: O4jOperat
         val parameters = mutableListOf<ParserParameter>()
 
         operation.parameters?.map { p: O4jParameter ->
-            parameters.add(Parameter(p))
+            var param = p
+            if(p.isRef) {
+                param = refResolver.resolve(p)
+            }
+
+            parameters.add(Parameter(param))
         }
 
         return parameters

src/main/kotlin/io/openapiprocessor/core/parser/openapi4j/Path.kt

@@ -26,7 +26,11 @@ import org.openapi4j.parser.model.v3.Path as Oa4jPath
  *
  * @author Martin Hauner
  */
-class Path(private val path: String, private val info: Oa4jPath): ParserPath {
+class Path(
+    private val path: String,
+    private val info: Oa4jPath,
+    private val refResolver: RefResolverNative
+): ParserPath {
 
     override fun getPath(): String = path
 
@@ -36,7 +40,7 @@ class Path(private val path: String, private val info: Oa4jPath): ParserPath {
         HttpMethod.values().map {
             val op = info.getOperation(it.method)
             if (op != null) {
-                ops.add (Operation(it, op))
+                ops.add (Operation(it, op, refResolver))
             }
         }
 

src/main/kotlin/io/openapiprocessor/core/parser/openapi4j/RefResolverNative.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright © 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.parser.openapi4j
+
+import org.openapi4j.parser.model.v3.OpenApi3
+import org.openapi4j.parser.model.v3.Path as O4jPath
+import org.openapi4j.parser.model.v3.Parameter as O4jParameter
+
+/**
+ * openapi4j $ref resolver on o4j types. Resolves non-schema $ref's.
+ */
+class RefResolverNative(private val api: OpenApi3) {
+
+    fun resolve(path: O4jPath): O4jPath {
+        return path.getReference(api.context).getMappedContent(O4jPath::class.java)
+    }
+
+    fun resolve(param: O4jParameter): O4jParameter {
+        return param.getReference(api.context).getMappedContent(O4jParameter::class.java)
+    }
+
+}

src/testInt/groovy/com/github/hauner/openapi/processor/core/ProcessorEndToEndTest.groovy

@@ -32,7 +32,8 @@ class ProcessorEndToEndTest extends ProcessorTestBase {
 
     static def testSets = TestSet.ALL + [
         'deprecated',
-        'ref-into-another-file-path'
+        'ref-into-another-file-path',
+        'ref-parameter'
     ]
 
     @Parameterized.Parameters(name = "{0}")

src/testInt/groovy/com/github/hauner/openapi/processor/core/ProcessorPendingTest.groovy

@@ -23,16 +23,17 @@ import com.github.hauner.openapi.test.TestSet
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.Parameterized
+import spock.lang.Ignore
 
-//@Ignore
+@Ignore
 @RunWith(Parameterized)
 class ProcessorPendingTest extends ProcessorTestBase {
 
     @Parameterized.Parameters(name = "{0}")
     static Collection<TestSet> sources () {
         return [
-            new TestSet(name: 'ref-array-items-nested', processor: new TestProcessor(), parser: ParserType.OPENAPI4J),
-            new TestSet(name: 'ref-array-items-nested', processor: new TestProcessor(), parser: ParserType.SWAGGER)
+            new TestSet(name: 'ref-parameter', processor: new TestProcessor(), parser: ParserType.OPENAPI4J),
+            new TestSet(name: 'ref-parameter', processor: new TestProcessor(), parser: ParserType.SWAGGER)
         ]
     }
 

src/testInt/resources/tests/ref-parameter/generated.yaml

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

src/testInt/resources/tests/ref-parameter/generated/api/Api.java

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

src/testInt/resources/tests/ref-parameter/inputs.yaml

@@ -0,0 +1,2 @@
+items:
+  - inputs/openapi.yaml

src/testInt/resources/tests/ref-parameter/inputs/openapi.yaml

@@ -0,0 +1,25 @@
+openapi: 3.0.3
+info:
+  title: ref parameters
+  version: 1.0.0
+
+paths:
+  /foo:
+    get:
+      parameters:
+        - $ref: "#/components/parameters/Bar"
+      responses:
+        '200':
+          description: plain text response
+          content:
+            plain/text:
+              schema:
+                type: string
+
+components:
+  parameters:
+    Bar:
+      in: query
+      name: bar
+      schema:
+        type: string