openapi-processor/openapi-processor-spring#124, improve name handling of $ref's

Author: hauner

src/main/kotlin/io/openapiprocessor/core/parser/RefResolver.kt

@@ -18,11 +18,12 @@ package io.openapiprocessor.core.parser
 
 /**
  * Resolves $ref objects from an OpenAPI.
- *
- * @author Martin Hauner
  */
 interface RefResolver {
+    fun resolve(ref: Schema): NamedSchema
+}
 
-    fun resolve(ref: Schema): Schema
-
+class NamedSchema(val name: String?, val schema: Schema) {
+    val hasName = name != null
+    val hasNoName = name == null
 }

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

@@ -16,6 +16,7 @@
 
 package io.openapiprocessor.core.parser.openapi4j
 
+import io.openapiprocessor.core.parser.NamedSchema
 import io.openapiprocessor.core.parser.RefResolver as ParserRefResolver
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 import org.openapi4j.parser.model.v3.OpenApi3 as O4jOpenApi
@@ -28,7 +29,7 @@ import org.openapi4j.parser.model.v3.Schema as O4jSchema
  */
 class RefResolver(private val api: O4jOpenApi): ParserRefResolver {
 
-    override fun resolve(ref: ParserSchema): ParserSchema {
+    override fun resolve(ref: ParserSchema): NamedSchema {
         val resolved: O4jSchema
 
         val refName = getRefName(ref.getRef()!!)
@@ -40,11 +41,16 @@ class RefResolver(private val api: O4jOpenApi): ParserRefResolver {
             o4jSchema.getReference(api.context).getMappedContent(O4jSchema::class.java)
         }
 
-        return Schema (resolved)
+        return NamedSchema (refName, Schema(resolved))
     }
 
-    private fun getRefName(ref: String): String {
-        return ref.substring(ref.lastIndexOf('/') + 1)
+    private fun getRefName(ref: String): String? {
+        val split = ref.split('#')
+        if (split.size > 1) {
+            val hash = split[1]
+            return hash.substring(hash.lastIndexOf('/') + 1)
+        }
+        return null
     }
 
 }

src/main/kotlin/io/openapiprocessor/core/parser/swagger/RefResolver.kt

@@ -16,6 +16,7 @@
 
 package io.openapiprocessor.core.parser.swagger
 
+import io.openapiprocessor.core.parser.NamedSchema as ParserNamedSchema
 import io.openapiprocessor.core.parser.RefResolver as ParserRefResolver
 import io.openapiprocessor.core.parser.Schema as ParserSchema
 import io.swagger.v3.oas.models.media.Schema as SwaggerSchema
@@ -28,19 +29,24 @@ import io.swagger.v3.oas.models.OpenAPI
  */
 class RefResolver(private val openapi: OpenAPI): ParserRefResolver {
 
-    override fun resolve(ref: ParserSchema): ParserSchema {
+    override fun resolve(ref: ParserSchema): ParserNamedSchema {
         val refName = getRefName(ref.getRef()!!)
 
         val schema: SwaggerSchema<*>? = openapi.components?.schemas?.get(refName)
         if (schema == null) {
             throw Exception("failed to resolve ${ref.getRef()}")
         }
 
-        return Schema(schema)
+        return ParserNamedSchema(refName, Schema(schema))
     }
 
-    private fun getRefName(ref: String): String {
-        return ref.substring(ref.lastIndexOf('/') + 1)
+    private fun getRefName(ref: String): String? {
+        val split = ref.split('#')
+        if (split.size > 1) {
+            val hash = split[1]
+            return hash.substring(hash.lastIndexOf('/') + 1)
+        }
+        return null
     }
 
 }

src/test/groovy/com/github/hauner/openapi/core/converter/DataTypeConverterSpec.groovy

@@ -29,8 +29,10 @@ import io.openapiprocessor.core.model.HttpMethod
 import io.openapiprocessor.core.model.datatypes.ObjectDataType
 import com.github.hauner.openapi.core.test.TestSchema
 import io.openapiprocessor.core.converter.mapping.UnknownDataTypeException
+import io.openapiprocessor.core.parser.NamedSchema
 import io.openapiprocessor.core.parser.RefResolver
 import io.openapiprocessor.core.parser.Schema
+import org.jetbrains.annotations.NotNull
 import spock.lang.Specification
 import spock.lang.Unroll
 
@@ -126,9 +128,10 @@ class DataTypeConverterSpec extends Specification {
         ])
 
         def resolver = new RefResolver () {
+
             @Override
-            Schema resolve (Schema ref) {
-                barSchema
+            NamedSchema resolve (@NotNull Schema ref) {
+                return new NamedSchema("Bar", barSchema)
             }
         }