add schema default value to data type

Author: hauner

src/main/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverter.groovy

@@ -29,6 +29,7 @@ import com.github.hauner.openapi.spring.model.DataTypes
 import com.github.hauner.openapi.spring.model.datatypes.ArrayDataType
 import com.github.hauner.openapi.spring.model.datatypes.BooleanDataType
 import com.github.hauner.openapi.spring.model.datatypes.CollectionDataType
+import com.github.hauner.openapi.spring.model.datatypes.DataTypeConstraints
 import com.github.hauner.openapi.spring.model.datatypes.ListDataType
 import com.github.hauner.openapi.spring.model.datatypes.LocalDateDataType
 import com.github.hauner.openapi.spring.model.datatypes.MapDataType
@@ -171,6 +172,9 @@ class DataTypeConverter {
             typeFormat += '/' + schemaInfo.format
         }
 
+        def defaultValue = schemaInfo.defaultValue
+        def constraints = defaultValue ? new DataTypeConstraints(defaultValue: defaultValue) : null
+
         def simpleType
         switch (typeFormat) {
             case 'integer':
@@ -191,7 +195,7 @@ class DataTypeConverter {
                 simpleType = new BooleanDataType ()
                 break
             case 'string':
-                simpleType = createStringDataType (schemaInfo, dataTypes)
+                simpleType = createStringDataType (schemaInfo, constraints, dataTypes)
                 break
             case 'string/date':
                 simpleType = new LocalDateDataType ()
@@ -206,17 +210,18 @@ class DataTypeConverter {
         simpleType
     }
 
-    private DataType createStringDataType (SchemaInfo info, DataTypes dataTypes) {
+    private DataType createStringDataType (SchemaInfo info, DataTypeConstraints constraints, DataTypes dataTypes) {
         if (!info.isEnum()) {
-            return new StringDataType ()
+            return new StringDataType (constraints: constraints)
         }
 
         // in case of an inline definition the name may be lowercase, make sure the enum
         // class gets an uppercase name!
         def enumType = new StringEnumDataType (
             type: info.name.capitalize (),
             pkg: [options.packageName, 'model'].join ('.'),
-            values: info.enumValues)
+            values: info.enumValues,
+            constraints: constraints)
 
         dataTypes.add (enumType)
         enumType

src/main/groovy/com/github/hauner/openapi/spring/converter/schema/SchemaInfo.groovy

@@ -125,6 +125,15 @@ class SchemaInfo {
         schema.$ref
     }
 
+    /**
+     * get default value.
+     *
+     * @return default value or null
+     */
+    def getDefaultValue() {
+        schema.default
+    }
+
     /**
      * get the custom Java type (fully qualified) defined via the {@code x-java-type} OpenAPI
      * extension. If no {@code x-java-type} is set the result is {@code null}.

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/DataTypeConstraints.groovy

@@ -19,8 +19,12 @@ package com.github.hauner.openapi.spring.model.datatypes
 /**
  * OpenAPI constraint details of a data type.
  */
-interface DataTypeConstraints<T> {
+class DataTypeConstraints {
 
-    T getDefault()
+    def defaultValue
+
+    String getDefault () {
+        defaultValue
+    }
 
 }

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/StringDataType.groovy

@@ -23,7 +23,7 @@ package com.github.hauner.openapi.spring.model.datatypes
  */
 class StringDataType implements DataType {
 
-    StringDataTypeConstraints constraints
+    DataTypeConstraints constraints
 
     @Override
     String getName () {
@@ -46,7 +46,7 @@ class StringDataType implements DataType {
     }
 
     @Override
-    DataTypeConstraints<String> getConstraints() {
+    DataTypeConstraints getConstraints() {
         constraints
     }
 

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/StringDataTypeConstraints.groovy

@@ -26,6 +26,7 @@ class StringEnumDataType implements DataType {
     String type
     String pkg = 'unknown'
     List<String> values = []
+    DataTypeConstraints constraints
 
     @Override
     String getName () {
@@ -47,6 +48,11 @@ class StringEnumDataType implements DataType {
         []
     }
 
+    @Override
+    DataTypeConstraints getConstraints() {
+        constraints
+    }
+
 }
 
 

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/StringEnumDataType.groovy

@@ -63,6 +63,17 @@ class DataTypeConverterSpec extends Specification {
         'boolean' | null        | 'Boolean'
     }
 
+    void "converts primitive schema with default value" () {
+        Schema schema = new Schema(type: 'string', _default: 'bar')
+
+        when:
+        def datatype = converter.convert (new SchemaInfo (null, schema, 'String'), new DataTypes())
+
+        then:
+        datatype.name == 'String'
+        datatype.constraints.default == 'bar'
+    }
+
     void "throws when hitting an unknown data type" () {
         Schema schema = new Schema(type: type, format: format)
 

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

@@ -22,6 +22,7 @@ import com.github.hauner.openapi.spring.model.RequestBody
 import com.github.hauner.openapi.spring.model.Response
 import com.github.hauner.openapi.spring.model.datatypes.BooleanDataType
 import com.github.hauner.openapi.spring.model.datatypes.CollectionDataType
+import com.github.hauner.openapi.spring.model.datatypes.DataTypeConstraints
 import com.github.hauner.openapi.spring.model.datatypes.DoubleDataType
 import com.github.hauner.openapi.spring.model.datatypes.FloatDataType
 import com.github.hauner.openapi.spring.model.datatypes.InlineObjectDataType
@@ -33,7 +34,6 @@ import com.github.hauner.openapi.spring.model.datatypes.NoneDataType
 import com.github.hauner.openapi.spring.model.datatypes.ObjectDataType
 import com.github.hauner.openapi.spring.model.datatypes.SetDataType
 import com.github.hauner.openapi.spring.model.datatypes.StringDataType
-import com.github.hauner.openapi.spring.model.datatypes.StringDataTypeConstraints
 import com.github.hauner.openapi.spring.model.parameters.CookieParameter
 import com.github.hauner.openapi.spring.model.parameters.HeaderParameter
 import com.github.hauner.openapi.spring.model.parameters.QueryParameter
@@ -373,7 +373,7 @@ class MethodWriterSpec extends Specification {
         ], parameters: [
             new QueryParameter(name: 'foo', required: false,
                 dataType: new StringDataType(
-                    constraints: new StringDataTypeConstraints (dfault: 'bar')))
+                    constraints: new DataTypeConstraints (defaultValue: 'bar')))
         ])
 
         when: