use type mapping from yaml

hauner · hauner · commit c9568e2d6f3c · 2019-11-04T22:50:52.000+01:00
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/ApiConverter.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/ApiConverter.groovy
@@ -16,8 +16,6 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
-import com.github.hauner.openapi.spring.generatr.DefaultApiOptions
 import com.github.hauner.openapi.spring.model.Api
 import com.github.hauner.openapi.spring.model.Endpoint
 import com.github.hauner.openapi.spring.model.parameters.QueryParameter
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/ApiOptions.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/ApiOptions.groovy
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr
+package com.github.hauner.openapi.spring.converter
 
 /**
  * Options of the generatr.
@@ -43,19 +43,14 @@ class ApiOptions {
      */
     String packageName
 
-    /**
-     * show warnings from the open api parser.
-     */
-    boolean showWarnings
-
     /**
      * provide additional type mapping information to map OpenAPI types to java types. The list can
      * contain the following mappings:
      *
-     * {@link com.github.hauner.openapi.spring.generatr.mapping.TypeMapping}: used to globally override
+     * {@link com.github.hauner.openapi.spring.converter.mapping.TypeMapping}: used to globally override
      * the mapping of an OpenAPI schema to a specific java type.
      *
-     * {@link com.github.hauner.openapi.spring.generatr.mapping.EndpointTypeMapping}: used to override
+     * {@link com.github.hauner.openapi.spring.converter.mapping.EndpointTypeMapping}: used to override
      * parameter, response type mappings or to add additional parameters on a single endpoint.
      */
     List<?> typeMappings
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverter.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverter.groovy
@@ -16,10 +16,9 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
-import com.github.hauner.openapi.spring.generatr.mapping.EndpointTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.ResponseTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.TypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.EndpointTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.ResponseTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.TypeMapping
 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
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/DefaultApiOptions.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/DefaultApiOptions.groovy
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr
+package com.github.hauner.openapi.spring.converter
 
 /**
  * ApiOptions defaults.
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/InterfaceCollector.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/InterfaceCollector.groovy
@@ -16,7 +16,6 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
 import com.github.hauner.openapi.spring.model.Interface
 import io.swagger.v3.oas.models.Operation
 import io.swagger.v3.oas.models.PathItem
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/EndpointTypeMapping.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/EndpointTypeMapping.groovy
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr.mapping
+package com.github.hauner.openapi.spring.converter.mapping
 
 /**
- * Used with {@link com.github.hauner.openapi.spring.generatr.ApiOptions} to override parameter or
+ * Used with {@link com.github.hauner.openapi.spring.converter.ApiOptions} to override parameter or
  * response type mappings on a single endpoint. It can also be used to add parameters that are not
  * defined in the api. For example to pass {@link javax.servlet.http.HttpServletRequest} to the
  * controller method.
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/ParameterTypeMapping.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/ParameterTypeMapping.groovy
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr.mapping
+package com.github.hauner.openapi.spring.converter.mapping
 
 /**
  * Used with {@link EndpointTypeMapping} to configure the java type that represents the schema of
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/ResponseTypeMapping.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/ResponseTypeMapping.groovy
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr.mapping
+package com.github.hauner.openapi.spring.converter.mapping
 
 /**
  * Used with {@link EndpointTypeMapping} to configure the java type that represents the response
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/TypeMapping.groovy b/src/main/groovy/com/github/hauner/openapi/spring/converter/mapping/TypeMapping.groovy
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr.mapping
+package com.github.hauner.openapi.spring.converter.mapping
 
 /**
- * Used with {@link com.github.hauner.openapi.spring.generatr.ApiOptions#typeMappings} to map an
+ * Used with {@link com.github.hauner.openapi.spring.converter.ApiOptions#typeMappings} to map an
  * OpenAPI schema to a java type.
  *
  * To override the type mapping of the OpenAPI {@code array} from a simple java array to another
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/generatr/SpringGeneratr.groovy b/src/main/groovy/com/github/hauner/openapi/spring/generatr/SpringGeneratr.groovy
@@ -18,6 +18,7 @@ package com.github.hauner.openapi.spring.generatr
 
 import com.github.hauner.openapi.api.OpenApiGeneratr
 import com.github.hauner.openapi.spring.converter.ApiConverter
+import com.github.hauner.openapi.spring.converter.ApiOptions
 import com.github.hauner.openapi.spring.writer.ApiWriter
 import com.github.hauner.openapi.spring.writer.HeaderWriter
 import com.github.hauner.openapi.spring.writer.InterfaceWriter
@@ -31,33 +32,34 @@ import io.swagger.v3.parser.core.models.SwaggerParseResult
  *
  *  @author Martin Hauner
  */
-class SpringGeneratr implements OpenApiGeneratr<ApiOptions> {
+class SpringGeneratr implements OpenApiGeneratr<SpringGeneratrOptions> {
 
     @Override
     String getName () {
         return 'spring'
     }
 
     @Override
-    Class<ApiOptions> getOptionsType () {
-        return ApiOptions
+    Class<SpringGeneratrOptions> getOptionsType () {
+        return SpringGeneratrOptions
     }
 
     @Override
-    void run (ApiOptions options) {
+    void run (SpringGeneratrOptions generatrOptions) {
         ParseOptions opts = new ParseOptions(
             // loads $refs to other files into #/components/schema and replaces the $refs to the
             // external files with $refs to #/components/schema.
             resolve: true
         )
 
         SwaggerParseResult result = new OpenAPIV3Parser ()
-        .readLocation (options.apiPath, null, opts)
+        .readLocation (generatrOptions.apiPath, null, opts)
 
-        if (options.showWarnings) {
+        if (generatrOptions.showWarnings) {
             printWarnings(result.messages)
         }
 
+        def options = convertOptions (generatrOptions)
         def cv = new ApiConverter(options)
         def api = cv.convert (result.openAPI)
 
@@ -70,6 +72,16 @@ class SpringGeneratr implements OpenApiGeneratr<ApiOptions> {
         writer.write (api)
     }
 
+    private ApiOptions convertOptions (SpringGeneratrOptions generatrOptions) {
+        def options = new ApiOptions()
+        def reader = new TypeMappingReader ()
+        options.apiPath = generatrOptions.apiPath
+        options.targetDir = generatrOptions.targetDir
+        options.packageName = generatrOptions.packageName
+        options.typeMappings = reader.read (generatrOptions.typeMappings)
+        options
+    }
+
     private static printWarnings(List<String> warnings) {
         if (warnings.empty) {
             return
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/generatr/SpringGeneratrOptions.groovy b/src/main/groovy/com/github/hauner/openapi/spring/generatr/SpringGeneratrOptions.groovy
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2019 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi.spring.generatr
+
+/**
+ * Public options of the generatr.
+ *
+ * @author Martin Hauner
+ */
+class SpringGeneratrOptions {
+
+    /**
+     * the path to the open api yaml file.
+     */
+    String apiPath
+
+    /**
+     * the destination folder for generating interfaces & models. This is the parent of the
+     * {@link #packageName} folder tree.
+     */
+    String targetDir
+
+    /**
+     * the root package of the generated interfaces/model. The package folder tree will be created
+     * inside {@link #targetDir}. Interfaces and models will be placed into the "api" and "model"
+     * subpackages of packageName:
+     * - interfaces => "${packageName}.api"
+     * - models => "${packageName}.model"
+     */
+    String packageName
+
+    /**
+     * show warnings from the open api parser.
+     */
+    boolean showWarnings
+
+    /**
+     * Either a type mapping yaml as string or a file name to a type mapping yaml. Note that the yaml
+     * file name must end with either {@code .yaml} or {@code .yml}.
+     */
+    String typeMappings
+
+}
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/generatr/TypeMappingReader.groovy b/src/main/groovy/com/github/hauner/openapi/spring/generatr/TypeMappingReader.groovy
@@ -16,10 +16,10 @@
 
 package com.github.hauner.openapi.spring.generatr
 
-import com.github.hauner.openapi.spring.generatr.mapping.EndpointTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.ParameterTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.ResponseTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.TypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.EndpointTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.ParameterTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.ResponseTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.TypeMapping
 import org.yaml.snakeyaml.Yaml
 
 import java.util.regex.Matcher
@@ -95,7 +95,10 @@ class TypeMappingReader {
     private ResponseTypeMapping readResponseTypeMapping (Map<String, ?> source) {
         def content = source.content
         def mapping = readTypMapping (source)
-        new ResponseTypeMapping(contentType: content, mapping: mapping)
+        new ResponseTypeMapping(contentType: content, mapping: mapping,
+            sourceTypeName: mapping.sourceTypeName,
+            targetTypeName: mapping.targetTypeName
+        )
     }
 
     private TypeMapping readTypMapping (Map<String, ?> source) {
diff --git a/src/main/groovy/com/github/hauner/openapi/spring/writer/ApiWriter.groovy b/src/main/groovy/com/github/hauner/openapi/spring/writer/ApiWriter.groovy
@@ -16,7 +16,7 @@
 
 package com.github.hauner.openapi.spring.writer
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
+import com.github.hauner.openapi.spring.converter.ApiOptions
 import com.github.hauner.openapi.spring.model.Api
 import com.github.hauner.openapi.spring.model.datatypes.ObjectDataType
 import groovy.util.logging.Slf4j
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/converter/ApiConverterSetupSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/converter/ApiConverterSetupSpec.groovy
@@ -16,7 +16,7 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.DefaultApiOptions
+
 import spock.lang.Specification
 
 class ApiConverterSetupSpec extends Specification {
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverterResponseTypeMappingSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverterResponseTypeMappingSpec.groovy
@@ -16,12 +16,10 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
-import com.github.hauner.openapi.spring.generatr.mapping.EndpointTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.ResponseTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.TypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.EndpointTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.ResponseTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.TypeMapping
 import com.github.hauner.openapi.spring.model.Api
-import spock.lang.Ignore
 import spock.lang.Specification
 import spock.lang.Unroll
 
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverterSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/converter/DataTypeConverterSpec.groovy
@@ -16,8 +16,7 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
-import com.github.hauner.openapi.spring.generatr.DefaultApiOptions
+
 import com.github.hauner.openapi.spring.model.Api
 import com.github.hauner.openapi.spring.model.DataTypes
 import io.swagger.v3.oas.models.media.ObjectSchema
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/converter/DataTypesConverterGlobalTypeMappingSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/converter/DataTypesConverterGlobalTypeMappingSpec.groovy
@@ -16,8 +16,7 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
-import com.github.hauner.openapi.spring.generatr.mapping.TypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.TypeMapping
 import com.github.hauner.openapi.spring.model.Api
 import spock.lang.Specification
 
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/converter/InterfaceCollectorSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/converter/InterfaceCollectorSpec.groovy
@@ -16,8 +16,7 @@
 
 package com.github.hauner.openapi.spring.converter
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
-import com.github.hauner.openapi.spring.generatr.DefaultApiOptions
+
 import io.swagger.v3.oas.models.Operation
 import io.swagger.v3.oas.models.PathItem
 import io.swagger.v3.oas.models.Paths
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/generatr/TypeMappingReaderSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/generatr/TypeMappingReaderSpec.groovy
@@ -16,16 +16,14 @@
 
 package com.github.hauner.openapi.spring.generatr
 
-import com.github.hauner.openapi.spring.generatr.mapping.EndpointTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.ParameterTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.ResponseTypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.TypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.EndpointTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.ParameterTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.ResponseTypeMapping
+import com.github.hauner.openapi.spring.converter.mapping.TypeMapping
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
 import spock.lang.Specification
 
-import java.lang.reflect.Parameter
-
 class TypeMappingReaderSpec extends Specification {
 
     @Rule
diff --git a/src/test/groovy/com/github/hauner/openapi/spring/writer/ApiWriterSpec.groovy b/src/test/groovy/com/github/hauner/openapi/spring/writer/ApiWriterSpec.groovy
@@ -16,7 +16,7 @@
 
 package com.github.hauner.openapi.spring.writer
 
-import com.github.hauner.openapi.spring.generatr.ApiOptions
+import com.github.hauner.openapi.spring.converter.ApiOptions
 import com.github.hauner.openapi.spring.model.Api
 import com.github.hauner.openapi.spring.model.DataTypes
 import com.github.hauner.openapi.spring.model.Interface
diff --git a/src/testInt/groovy/com/github/hauner/openapi/generatr/GeneratrEndToEndTest.groovy b/src/testInt/groovy/com/github/hauner/openapi/generatr/GeneratrEndToEndTest.groovy
diff --git a/src/testInt/groovy/com/github/hauner/openapi/generatr/GeneratrTestBase.groovy b/src/testInt/groovy/com/github/hauner/openapi/generatr/GeneratrTestBase.groovy
diff --git a/src/testInt/groovy/com/github/hauner/openapi/generatr/TestSet.groovy b/src/testInt/groovy/com/github/hauner/openapi/generatr/TestSet.groovy
diff --git a/src/testInt/resources/response-array-data-type-mapping/mapping.yaml b/src/testInt/resources/response-array-data-type-mapping/mapping.yaml
