Initial swagger generation

Author: rbygrave

pom.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <groupId>io.dinject</groupId>
@@ -17,6 +18,10 @@
     <tag>HEAD</tag>
   </scm>
 
+  <properties>
+    <swagger.version>2.0.8</swagger.version>
+  </properties>
+
   <dependencies>
 
     <dependency>
@@ -31,6 +36,26 @@
       <version>1.6</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <version>2.9.8</version>
+    </dependency>
+
+    <dependency>
+      <groupId>io.swagger.core.v3</groupId>
+      <artifactId>swagger-models</artifactId>
+      <version>${swagger.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>io.swagger.core.v3</groupId>
+      <artifactId>swagger-annotations</artifactId>
+      <version>${swagger.version}</version>
+    </dependency>
+
+    <!-- test dependencies -->
+
     <dependency>
       <groupId>org.avaje.composite</groupId>
       <artifactId>junit</artifactId>

src/main/java/io/dinject/javalin/generator/Constants.java

@@ -6,6 +6,8 @@ class Constants {
 
   static final String JAVALIN_ROLES = "io.javalin.security.SecurityUtil.roles";
 
+  static final String OPENAPIDEFINITION = "io.swagger.v3.oas.annotations.OpenAPIDefinition";
+
   static final String SINGLETON = "javax.inject.Singleton";
   static final String GENERATED = "javax.annotation.Generated";
   static final String API_BUILDER = "io.javalin.apibuilder.ApiBuilder";

src/main/java/io/dinject/javalin/generator/ControllerReader.java

@@ -30,9 +30,12 @@ class ControllerReader {
 
   private final Set<String> importTypes = new TreeSet<>();
 
+//  private final String docComment;
+
   ControllerReader(TypeElement beanType, ProcessingContext ctx) {
     this.beanType = beanType;
     this.ctx = ctx;
+//    this.docComment = ctx.getDocComment(beanType);
     this.roles = Util.findRoles(beanType);
     if (ctx.isGeneratedAvailable()) {
       importTypes.add(Constants.GENERATED);
@@ -47,6 +50,10 @@ TypeElement getBeanType() {
     return beanType;
   }
 
+//  String getDocComment() {
+//    return docComment;
+//  }
+
   void read() {
     if (!roles.isEmpty()) {
       addStaticImportType(JAVALIN_ROLES);

src/main/java/io/dinject/javalin/generator/ControllerRouteWriter.java

@@ -11,11 +11,11 @@ class ControllerRouteWriter {
 
   private final ProcessingContext ctx;
 
-  private Append writer;
-  private String originName;
-  private String shortName;
-  private String packageName;
+  private final String originName;
+  private final String shortName;
   private final String fullName;
+  private String packageName;
+  private Append writer;
 
   ControllerRouteWriter(ControllerReader reader, ProcessingContext ctx) {
     this.reader = reader;
@@ -29,7 +29,7 @@ class ControllerRouteWriter {
 
   void write() throws IOException {
 
-    this.writer = new Append(createFileWriter());
+    writer = new Append(createFileWriter());
     writePackage();
     writeImports();
     writeClassStart();
@@ -46,6 +46,7 @@ private void writeAddRoutes() {
 
     for (MethodReader method : reader.getMethods()) {
       method.addRoute(writer);
+      method.addMeta(ctx);
     }
 
     writer.append("  }").eol().eol();
@@ -90,7 +91,6 @@ private void writePackage() {
     }
   }
 
-
   private Writer createFileWriter() throws IOException {
 
     int dp = originName.lastIndexOf('.');

src/main/java/io/dinject/javalin/generator/ElementReader.java

@@ -7,6 +7,10 @@
 import io.dinject.controller.FormParam;
 import io.dinject.controller.Header;
 import io.dinject.controller.QueryParam;
+import io.dinject.javalin.generator.javadoc.Javadoc;
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.parameters.Parameter;
 
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
@@ -24,7 +28,7 @@ class ElementReader {
   private ParamType paramType;
   private boolean impliedParamType;
   private String paramDefault;
-  private String docComment;
+//  private String docComment;
 
   ElementReader(Element element, ProcessingContext ctx, ParamType defaultType, boolean formMarker) {
     this.ctx = ctx;
@@ -35,7 +39,7 @@ class ElementReader {
     this.varName = element.getSimpleName().toString();
     this.snakeName = Util.snakeCase(varName);
     this.paramName = varName;
-    this.docComment = ctx.docComment(element);
+//    this.docComment = ctx.getDocComment(element);
 
     readAnnotations(element, defaultType);
   }
@@ -138,6 +142,22 @@ void writeParamName(Append writer) {
     }
   }
 
+  void addMeta(Javadoc javadoc, Operation operation) {
+    if (!isJavalinContext()) {
+
+      Parameter param = new Parameter();
+      param.setName(varName);
+      param.setDescription(javadoc.getParams().get(paramName));
+      param.setIn(paramType.getType());
+
+      Schema schema = new Schema();
+      schema.setType("string");
+      param.setSchema(schema);
+
+      operation.addParametersItem(param);
+    }
+  }
+
   void writeCtxGet(Append writer, PathSegments segments) {
 
     if (isJavalinContext()) {
@@ -162,6 +182,7 @@ private boolean setValue(Append writer, PathSegments segments, String shortType)
     if (formMarker && impliedParamType && typeHandler == null) {
       // @Form on method and this type is a "bean" so treat is as a form bean
       writeForm(writer, shortType, varName, ParamType.FORMPARAM);
+      paramType = ParamType.FORM;
       return false;
     }
 
@@ -188,6 +209,7 @@ private boolean setValue(Append writer, PathSegments segments, String shortType)
         if (asMethod != null) {
           writer.append(")");
         }
+        paramType = ParamType.PATHPARAM;
         return true;
       }
     }
@@ -201,6 +223,8 @@ private boolean setValue(Append writer, PathSegments segments, String shortType)
     if (typeHandler == null) {
       // assuming this is a body (POST, PATCH)
       writer.append("ctx.bodyAsClass(%s.class)", shortType);
+      paramType = ParamType.BODY;
+
     } else {
       if (hasParamDefault()) {
         writer.append("ctx.%s(\"%s\",\"%s\")", paramType, paramName, paramDefault);
@@ -222,4 +246,5 @@ private void writeForm(Append writer, String shortType, String varName, ParamTyp
     BeanParamReader form = new BeanParamReader(ctx, formBeanType, varName, shortType, defaultParamType);
     form.write(writer);
   }
+
 }

src/main/java/io/dinject/javalin/generator/MethodParam.java

@@ -1,5 +1,8 @@
 package io.dinject.javalin.generator;
 
+import io.dinject.javalin.generator.javadoc.Javadoc;
+import io.swagger.v3.oas.models.Operation;
+
 import javax.lang.model.element.VariableElement;
 
 class MethodParam {
@@ -21,4 +24,8 @@ void addImports(ControllerReader bean) {
   void buildParamName(Append writer) {
     elementParam.writeParamName(writer);
   }
+
+  void addMeta(Javadoc javadoc, Operation operation) {
+    elementParam.addMeta(javadoc, operation);
+  }
 }

src/main/java/io/dinject/javalin/generator/MethodReader.java

@@ -6,6 +6,10 @@
 import io.dinject.controller.Patch;
 import io.dinject.controller.Post;
 import io.dinject.controller.Put;
+import io.dinject.javalin.generator.javadoc.Javadoc;
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.PathItem;
+import io.swagger.v3.oas.models.Paths;
 
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.element.VariableElement;
@@ -24,6 +28,8 @@ class MethodReader {
   private final List<MethodParam> params = new ArrayList<>();
   private final String beanPath;
 
+  private final Javadoc javadoc;
+
   private WebMethod webMethod;
   private String webMethodPath;
 
@@ -34,13 +40,18 @@ class MethodReader {
    */
   private final List<String> methodRoles;
 
+  private String fullPath;
+
+  private PathSegments segments;
+
   MethodReader(ControllerReader bean, ExecutableElement element, ProcessingContext ctx) {
     this.ctx = ctx;
     this.bean = bean;
     this.beanPath = bean.getPath();
     this.element = element;
     this.isVoid = element.getReturnType().toString().equals("void");
     this.methodRoles = Util.findRoles(element);
+    this.javadoc = Javadoc.parse(ctx.getDocComment(element));
 
     readMethodAnnotation();
   }
@@ -64,12 +75,45 @@ void read() {
     }
   }
 
+  public void addMeta(ProcessingContext ctx) {
+
+    if (webMethod != null) {
+
+      Paths paths = ctx.getOpenAPI().getPaths();
+
+      PathItem pathItem = paths.get(fullPath);
+      if (pathItem == null) {
+        pathItem = new PathItem();
+        paths.addPathItem(fullPath, pathItem);
+      }
+
+      Operation operation = new Operation();
+      //operation.setDeprecated();
+      //operation.setOperationId();
+      operation.setSummary(javadoc.getSummary());
+      operation.setDescription(javadoc.getDescription());
+
+      switch (webMethod) {
+        case GET: pathItem.setGet(operation); break;
+        case PUT: pathItem.setPut(operation); break;
+        case POST: pathItem.setPost(operation); break;
+        case DELETE: pathItem.setDelete(operation); break;
+        case PATCH: pathItem.setPatch(operation); break;
+      }
+
+      for (MethodParam param : params) {
+        param.addMeta(javadoc, operation);
+      }
+    }
+  }
+
+
   void addRoute(Append writer) {
 
     if (webMethod != null) {
 
-      String fullPath = Util.combinePath(beanPath, webMethodPath);
-      PathSegments segments = PathSegments.parse(fullPath);
+      fullPath = Util.combinePath(beanPath, webMethodPath);
+      segments = PathSegments.parse(fullPath);
 
       writer.append("    ApiBuilder.%s(\"%s\", ctx -> {", webMethod.name().toLowerCase(), segments.fullPath()).eol();
       writer.append("      ctx.status(%s);", httpStatusCode()).eol();
@@ -143,12 +187,10 @@ private boolean readMethodAnnotation() {
     if (get != null) {
       return setWebMethod(WebMethod.GET, get.value());
     }
-
     Put put = element.getAnnotation(Put.class);
     if (put != null) {
       return setWebMethod(WebMethod.PUT, put.value());
     }
-
     Post post = element.getAnnotation(Post.class);
     if (post != null) {
       return setWebMethod(WebMethod.POST, post.value());
@@ -161,7 +203,6 @@ private boolean readMethodAnnotation() {
     if (delete != null) {
       return setWebMethod(WebMethod.DELETE, delete.value());
     }
-
     return false;
   }
 

src/main/java/io/dinject/javalin/generator/ParamType.java

@@ -2,17 +2,25 @@
 
 enum ParamType {
 
-  FORM("form"),
-  BEANPARAM("beanParam"),
-  QUERYPARAM("queryParam"),
-  FORMPARAM("formParam"),
-  COOKIE("cookie"),
-  HEADER("header");
+  BODY("body", "body"),
+  PATHPARAM("pathParam", "path"),
+  FORM("form", "form"),
+  BEANPARAM("beanParam", "bean"),
+  QUERYPARAM("queryParam", "query"),
+  FORMPARAM("formParam", "form"),
+  COOKIE("cookie", "cookie"),
+  HEADER("header", "header");
 
   private String code;
+  private String type;
 
-  ParamType(String code) {
+  ParamType(String code, String type) {
     this.code = code;
+    this.type = type;
+  }
+
+  public String getType() {
+    return type;
   }
 
   @Override