Support Hidden methods and controllers

Author: rbygrave

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

@@ -1,6 +1,7 @@
 package io.dinject.javalin.generator;
 
 import io.dinject.controller.Path;
+import io.swagger.v3.oas.annotations.Hidden;
 
 import javax.lang.model.element.Element;
 import javax.lang.model.element.ElementKind;
@@ -30,29 +31,35 @@ class ControllerReader {
 
   private final Set<String> importTypes = new TreeSet<>();
 
-//  private final String docComment;
+  private boolean docHidden;
 
   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);
     }
+    if (ctx.isOpenApiAvailable()) {
+      docHidden = isDocHidden(beanType);
+    }
     importTypes.add(Constants.SINGLETON);
     importTypes.add(Constants.API_BUILDER);
     importTypes.add(Constants.IMPORT_CONTROLLER);
     importTypes.add(beanType.getQualifiedName().toString());
   }
 
+  private boolean isDocHidden(TypeElement beanType) {
+    return beanType.getAnnotation(Hidden.class) != null;
+  }
+
   TypeElement getBeanType() {
     return beanType;
   }
 
-//  String getDocComment() {
-//    return docComment;
-//  }
+  boolean isDocHidden() {
+    return docHidden;
+  }
 
   void read() {
     if (!roles.isEmpty()) {

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

@@ -46,7 +46,9 @@ private void writeAddRoutes() {
 
     for (MethodReader method : reader.getMethods()) {
       method.addRoute(writer);
-      method.addMeta(ctx);
+      if (!reader.isDocHidden()) {
+        method.addMeta(ctx);
+      }
     }
 
     writer.append("  }").eol().eol();

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

@@ -7,6 +7,7 @@
 import io.dinject.controller.Post;
 import io.dinject.controller.Put;
 import io.dinject.javalin.generator.javadoc.Javadoc;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.Paths;
@@ -77,7 +78,7 @@ void read() {
 
   public void addMeta(ProcessingContext ctx) {
 
-    if (webMethod != null) {
+    if (webMethod != null && notHidden()) {
 
       Paths paths = ctx.getOpenAPI().getPaths();
 
@@ -91,7 +92,7 @@ public void addMeta(ProcessingContext ctx) {
       //operation.setOperationId();
       operation.setSummary(javadoc.getSummary());
       operation.setDescription(javadoc.getDescription());
-      
+
       if (javadoc.isDeprecated()) {
         operation.setDeprecated(true);
       } else if (element.getAnnotation(Deprecated.class) != null) {
@@ -112,6 +113,12 @@ public void addMeta(ProcessingContext ctx) {
     }
   }
 
+  /**
+   * Return true if the method is included in documentation.
+   */
+  private boolean notHidden() {
+    return !ctx.isOpenApiAvailable() || element.getAnnotation(Hidden.class) == null;
+  }
 
   void addRoute(Append writer) {