ApiTool does not handle Upload correctly on mvc routes fix jooby-project#958

jknack · jknack · commit 25e9d7e3ede9 · 2018-01-02T20:54:13.000-03:00
diff --git a/modules/jooby-apitool/src/main/java/org/jooby/internal/apitool/SwaggerBuilder.java b/modules/jooby-apitool/src/main/java/org/jooby/internal/apitool/SwaggerBuilder.java
@@ -208,7 +208,11 @@
 import com.google.common.base.Splitter;
 import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableList;
+import com.google.inject.TypeLiteral;
+import io.swagger.converter.ModelConverter;
+import io.swagger.converter.ModelConverterContext;
 import io.swagger.converter.ModelConverters;
+import io.swagger.jackson.AbstractModelConverter;
 import io.swagger.models.Model;
 import io.swagger.models.Operation;
 import io.swagger.models.Path;
@@ -224,14 +228,18 @@
 import io.swagger.models.parameters.QueryParameter;
 import io.swagger.models.parameters.SerializableParameter;
 import io.swagger.models.properties.ArrayProperty;
+import io.swagger.models.properties.FileProperty;
 import io.swagger.models.properties.Property;
 import io.swagger.models.properties.PropertyBuilder;
 import io.swagger.models.properties.PropertyBuilder.PropertyId;
+import io.swagger.util.Json;
 import org.jooby.MediaType;
+import org.jooby.Upload;
 import org.jooby.apitool.RouteMethod;
 import org.jooby.apitool.RouteParameter;
 import org.jooby.apitool.RouteResponse;
 
+import java.lang.annotation.Annotation;
 import java.lang.reflect.Type;
 import java.util.EnumMap;
 import java.util.Iterator;
@@ -255,6 +263,25 @@ public class SwaggerBuilder {
   };
   private Function<RouteMethod, String> tagger = TAG_PROVIDER;
 
+  static {
+    /** Convert Upload to Swagger FileProperty: */
+    ModelConverters.getInstance().addConverter(new AbstractModelConverter(Json.mapper()) {
+      @Override public Property resolveProperty(Type type, ModelConverterContext context,
+          Annotation[] annotations, Iterator<ModelConverter> chain) {
+        TypeLiteral<?> typeLiteral = TypeLiteral.get(type);
+        String typeName = typeLiteral.getType().getTypeName();
+        if (typeName.equals("java.util.List<org.jooby.Upload>") ||
+            typeName.equals("java.util.Set<org.jooby.Upload>")) {
+          return new ArrayProperty(new FileProperty());
+        }
+        if (typeName.equals(Upload.class.getName())) {
+          return new FileProperty();
+        }
+        return super.resolveProperty(type, context, annotations, chain);
+      }
+    });
+  }
+
   public SwaggerBuilder() {
   }
 
diff --git a/modules/jooby-apitool/src/test/java/issues/Issue958.java b/modules/jooby-apitool/src/test/java/issues/Issue958.java
@@ -0,0 +1,77 @@
+package issues;
+
+import com.google.inject.util.Types;
+import io.swagger.models.HttpMethod;
+import io.swagger.models.Swagger;
+import io.swagger.models.parameters.FormParameter;
+import org.jooby.Upload;
+import org.jooby.apitool.RouteMethod;
+import org.jooby.apitool.RouteParameter;
+import org.jooby.apitool.RouteResponse;
+import org.jooby.internal.apitool.SwaggerBuilder;
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+
+import java.lang.reflect.Type;
+import java.util.Arrays;
+
+public class Issue958 {
+
+  @Test
+  public void shouldCreateSwaggerFile() throws Exception {
+    Swagger swagger = new SwaggerBuilder()
+        .build(null, Arrays.asList(route(fileParam("myfile", Upload.class))));
+    FormParameter parameter = (FormParameter) swagger
+        .getPath("/file")
+        .getOperationMap()
+        .get(HttpMethod.POST)
+        .getParameters()
+        .get(0);
+    assertEquals("formData", parameter.getIn());
+    assertEquals("myfile", parameter.getName());
+    assertEquals("file", parameter.getType());
+  }
+
+  @Test
+  public void shouldCreateSwaggerFiles() throws Exception {
+    Swagger swagger = new SwaggerBuilder()
+        .build(null, Arrays.asList(route(fileParam("files", Types.listOf(Upload.class)))));
+    FormParameter parameter = (FormParameter) swagger
+        .getPath("/file")
+        .getOperationMap()
+        .get(HttpMethod.POST)
+        .getParameters()
+        .get(0);
+    assertEquals("formData", parameter.getIn());
+    assertEquals("files", parameter.getName());
+    assertEquals("array", parameter.getType());
+    assertEquals("file", parameter.getItems().getType());
+  }
+
+  @Test
+  public void shouldCreateSwaggerFileSet() throws Exception {
+    Swagger swagger = new SwaggerBuilder()
+        .build(null, Arrays.asList(route(fileParam("fset", Types.setOf(Upload.class)))));
+    FormParameter parameter = (FormParameter) swagger
+        .getPath("/file")
+        .getOperationMap()
+        .get(HttpMethod.POST)
+        .getParameters()
+        .get(0);
+    assertEquals("formData", parameter.getIn());
+    assertEquals("fset", parameter.getName());
+    assertEquals("array", parameter.getType());
+    assertEquals("file", parameter.getItems().getType());
+  }
+
+  private RouteMethod route(RouteParameter... params) {
+    RouteMethod method = new RouteMethod("POST", "/file", new RouteResponse(String.class));
+    method.parameters(Arrays.asList(params));
+    return method;
+  }
+
+  private RouteParameter fileParam(String name, Type type) {
+    RouteParameter param = new RouteParameter(name, RouteParameter.Kind.FILE, type, null);
+    return param;
+  }
+}
