Merge pull request #228 from littleli/swagger-apimodelproperty-datatype

Use @ApiModelProperty attribute dataType to override target type

Author: vojtechhabarta

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/PropertyModel.java

@@ -66,6 +66,10 @@ public PropertyModel withComments(List<String> comments) {
         return new PropertyModel(name, type, optional, originalMember, pullProperties, comments);
     }
 
+    public PropertyModel withType(Type type) {
+        return new PropertyModel(name, type, optional, originalMember, pullProperties, comments);
+    }
+
     @Override
     public String toString() {
         return "PropertyModel{" + "name=" + name + ", type=" + type + "}";

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Swagger.java

@@ -2,9 +2,11 @@
 package cz.habarta.typescript.generator.parser;
 
 import cz.habarta.typescript.generator.util.Utils;
+
 import java.lang.annotation.Annotation;
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Method;
+import java.lang.reflect.Type;
 import java.util.*;
 
 
@@ -93,7 +95,17 @@ private static PropertyModel enrichProperty(PropertyModel property) {
             final AnnotatedElement annotatedElement = (AnnotatedElement) property.getOriginalMember();
             final String comment = Utils.getAnnotationElementValue(annotatedElement, "io.swagger.annotations.ApiModelProperty", "value", String.class);
             final List<String> comments = comment != null && !comment.isEmpty() ? Arrays.asList(comment) : null;
-            return property.withComments(Utils.concat(comments, property.getComments()));
+            final PropertyModel propertyModel = property.withComments(Utils.concat(comments, property.getComments()));
+            final String dataTypeString = Utils.getAnnotationElementValue(annotatedElement, "io.swagger.annotations.ApiModelProperty", "dataType", String.class);
+            if (dataTypeString == null || dataTypeString.isEmpty()) {
+                return propertyModel;
+            }
+            try {
+                final Type type = Class.forName(dataTypeString);
+                return propertyModel.withType(type);
+            } catch (ClassNotFoundException | ClassCastException e) {
+                return propertyModel;
+            }
         } else {
             return property;
         }

typescript-generator-core/src/test/java/cz/habarta/typescript/generator/SwaggerTest.java

@@ -44,6 +44,20 @@ public void testDocumentation() {
         Assert.assertTrue(output.contains("Not Found"));
         Assert.assertTrue(output.contains("Documentation for the bean."));
         Assert.assertTrue(output.contains("Documentation for property 1."));
+        Assert.assertTrue(output.contains("property1: string"));
+    }
+
+    @Test
+    public void testDocumentationAndDataType() {
+        final Settings settings = TestUtils.settings();
+        settings.generateJaxrsApplicationInterface = true;
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(DocumentedApplication.class));
+        Assert.assertTrue(output.contains("Documentation for operation 1."));
+        Assert.assertTrue(output.contains("Bad Request"));
+        Assert.assertTrue(output.contains("Not Found"));
+        Assert.assertTrue(output.contains("Documentation for the bean."));
+        Assert.assertTrue(output.contains("Documentation for property 2."));
+        Assert.assertTrue(output.contains("property2: string")); // see if type was overridden from number to string
     }
 
     private static class TestApplication extends Application {
@@ -128,6 +142,13 @@ private static class DocumentedBean {
 
         @ApiModelProperty("Documentation for property 1.")
         public String property1;
+
+        /**
+         * Sometimes custom serializers are used. In such cases target type is overridden explicitly
+         * with dataType annotation attribute.
+         */
+        @ApiModelProperty(value = "Documentation for property 2.", dataType = "java.lang.String")
+        public Long property2;
     }
 
 }