create response interfaces (#247)

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/DataTypeConverter.kt

@@ -217,14 +217,46 @@ class DataTypeConverter(
         }
 
         val found = dataTypes.find(schemaInfo.getName())
-        if (found != null) {
+        if (found != null && found is ObjectDataType) {
+            if (schemaInfo.withInterface()) {
+                return createInterface(schemaInfo, found, dataTypes)
+            }
+
             return found
         }
 
         dataTypes.add (schemaInfo.getName(), objectType)
         return objectType
     }
 
+    private fun createInterface(schemaInfo: SchemaInfo, objectType: ObjectDataType, dataTypes: DataTypes): DataType {
+        val constraints = DataTypeConstraints(
+            nullable = schemaInfo.getNullable(),
+            required = schemaInfo.getRequired())
+
+        val interfaceName = schemaInfo.interfaceName!!
+        val interfaceType = InterfaceDataType(
+            DataTypeName(interfaceName, getTypeNameWithSuffix2(interfaceName)),
+            listOf(options.packageName, "model").joinToString("."),
+            emptyList(),
+            constraints,
+            schemaInfo.getDeprecated(),
+            Documentation(description = schemaInfo.description)
+        )
+
+        val found = dataTypes.find(interfaceType.getName())
+        if (found != null && found is InterfaceDataType) {
+            found.addItem(objectType)
+            objectType.addInterface(found)
+            return found
+        }
+
+        interfaceType.addItem(objectType)
+        objectType.addInterface(interfaceType)
+        dataTypes.add (interfaceType.getName(), interfaceType)
+        return interfaceType
+    }
+
     private fun createObjectDataType(
         schemaInfo: SchemaInfo,
         properties: LinkedHashMap<String, PropertyDataType>
@@ -525,4 +557,8 @@ class DataTypeConverter(
     private fun getTypeNameWithSuffix(name: String): String {
         return identifier.toClass(name, options.modelNameSuffix)
     }
+
+    private fun getTypeNameWithSuffix2(name: String): String {
+        return name + options.modelNameSuffix
+    }
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/SchemaInfo.kt

@@ -353,6 +353,8 @@ open class SchemaInfo(
             resolver = resolver)
     }
 
+    val interfaceName: String? = contentTypeInterfaceName
+
     /**
      * all constraints
      */

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/DataTypes.kt

@@ -129,6 +129,19 @@ class DataTypes {
     val size: Int
         get() = dataTypeInfos.size
 
+    /**
+     * copy the data types. The data types itself are not copied but referenced. The ref count is not copied.
+     */
+    fun copy(): DataTypes {
+        val copy = DataTypes()
+
+        for ((k, v) in dataTypeInfos) {
+            copy.dataTypeInfos.put(k, DataTypeInfo(v.dataType))
+        }
+
+        return copy
+    }
+
     /**
      * test only. Provides all named data types (including simple data types) used by the api endpoints.
      *

openapi-processor-core/src/test/groovy/io/openapiprocessor/core/converter/DataTypeConverterDeprecatedSpec.groovy

@@ -42,7 +42,9 @@ class DataTypeConverterDeprecatedSpec extends Specification {
                 "",
                 schema,
                 Stub(RefResolver),
-                ""),
+                "",
+                false,
+                null),
             new DataTypes())
 
         then:

openapi-processor-core/src/test/groovy/io/openapiprocessor/core/converter/DataTypeConverterSpec.groovy

@@ -42,7 +42,9 @@ class DataTypeConverterSpec extends Specification {
                 "",
                 schema,
                 Stub(RefResolver),
-                ""),
+                "",
+                false,
+                null),
             new DataTypes())
 
         then:
@@ -74,7 +76,9 @@ class DataTypeConverterSpec extends Specification {
                 "",
                 schema,
                 Stub(RefResolver),
-                ""),
+                "",
+                false,
+                null),
             new DataTypes())
 
         then:
@@ -103,7 +107,9 @@ class DataTypeConverterSpec extends Specification {
             "",
             schema,
             Stub (RefResolver),
-            ""),
+            "",
+            false,
+            null),
             new DataTypes())
 
         then:
@@ -143,7 +149,9 @@ class DataTypeConverterSpec extends Specification {
                 "",
                 barSchema,
                 Stub(RefResolver),
-                ""),
+                "",
+                false,
+                null),
             dt)
         converter.convert (
             new SchemaInfo (
@@ -152,7 +160,9 @@ class DataTypeConverterSpec extends Specification {
                 "",
                 fooSchema,
                 resolver,
-                ""),
+                "",
+                false,
+                null),
             dt)
 
         then: