fixes #149 Generation of REST /health and /server/info endpoints shal…

…l be configurable
networknt · Aug 22, 2018 · add7cc9 · add7cc9
1 parent 7e8ed7b
commit add7cc9
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 9 deletions.
diff --git a/light-rest-4j/src/main/java/com/networknt/codegen/rest/OpenApiGenerator.java b/light-rest-4j/src/main/java/com/networknt/codegen/rest/OpenApiGenerator.java
@@ -37,6 +37,9 @@
 public class OpenApiGenerator implements Generator {
     private Map<String, String> typeMapping = new HashMap<>();
     boolean prometheusMetrics =false;
+    boolean skipHealthCheck = false;
+    boolean skipServerInfo = false;
+
     public OpenApiGenerator() {
         typeMapping.put("array", "java.util.List");
         typeMapping.put("map", "java.util.Map");
@@ -86,6 +89,9 @@ public void generate(String targetPath, Object model, Any config) throws IOExcep
         boolean supportClient = config.toBoolean("supportClient");
         String dockerOrganization = config.toString("dockerOrganization");
         prometheusMetrics = config.toBoolean("prometheusMetrics");
+        skipHealthCheck = config.toBoolean("skipHealthCheck");
+        skipServerInfo = config.toBoolean("skipServerInfo");
+
         String version = config.toString("version");
         String serviceId = config.get("groupId") + "." + config.get("artifactId") + "-" + config.get("version");
 
@@ -134,7 +140,7 @@ public void generate(String targetPath, Object model, Any config) throws IOExcep
 
         List<Map<String, Object>> operationList = getOperationList(model);
         // routing
-        transfer(targetPath, ("src.main.resources.config").replace(".", separator), "handler.yml", templates.rest.openapi.handlerYml.template(serviceId, handlerPackage, operationList, prometheusMetrics));
+        transfer(targetPath, ("src.main.resources.config").replace(".", separator), "handler.yml", templates.rest.openapi.handlerYml.template(serviceId, handlerPackage, operationList, prometheusMetrics, !skipHealthCheck, !skipServerInfo));
 
         // model
         Any anyComponents;

diff --git a/light-rest-4j/src/main/java/com/networknt/codegen/rest/SwaggerGenerator.java b/light-rest-4j/src/main/java/com/networknt/codegen/rest/SwaggerGenerator.java
@@ -35,6 +35,8 @@ public class SwaggerGenerator implements Generator {
 
     private Map<String, String> typeMapping = new HashMap<>();
     boolean prometheusMetrics =false;
+    boolean skipHealthCheck = false;
+    boolean skipServerInfo = false;
     public SwaggerGenerator() {
         typeMapping.put("array", "java.util.List");
         typeMapping.put("map", "java.util.Map");
@@ -84,6 +86,8 @@ public void generate(String targetPath, Object model, Any config) throws IOExcep
         boolean supportClient = config.toBoolean("supportClient");
         String dockerOrganization = config.toString("dockerOrganization");
         prometheusMetrics = config.toBoolean("prometheusMetrics");
+        skipHealthCheck = config.toBoolean("skipHealthCheck");
+        skipServerInfo = config.toBoolean("skipServerInfo");
         String version = config.toString("version");
         String serviceId = config.get("groupId") + "." + config.get("artifactId") + "-" + config.get("version");
 
@@ -132,8 +136,7 @@ public void generate(String targetPath, Object model, Any config) throws IOExcep
 
         List<Map<String, Any>> operationList = getOperationList(model);
         // routing
-        transfer(targetPath, ("src.main.resources.config").replace(".", separator), "handler.yml", templates.rest.swagger.handlerYml.template(serviceId, handlerPackage, operationList, prometheusMetrics));
-
+        transfer(targetPath, ("src.main.resources.config").replace(".", separator), "handler.yml", templates.rest.swagger.handlerYml.template(serviceId, handlerPackage, operationList, prometheusMetrics, !skipHealthCheck, !skipServerInfo));
 
         // model
         Any any = ((Any)model).get("definitions");

diff --git a/light-rest-4j/src/main/resources/templates/rest/openapi/handlerYml.rocker.raw b/light-rest-4j/src/main/resources/templates/rest/openapi/handlerYml.rocker.raw
@@ -1,7 +1,7 @@
 @import java.util.Map
 @import java.util.List
 @import com.jsoniter.any.Any
-@args (String serviceId, String handlerPackage, List<Map<String, Object>> items, boolean prometheusMetrics)
+@args (String serviceId, String handlerPackage, List<Map<String, Object>> items, boolean prometheusMetrics, boolean healthCheck, boolean serverInfo)
 
 # Handler middleware chain configuration
 ---
@@ -75,14 +75,16 @@ paths:
       - default
       - @with (p = handlerPackage + ".") {@p}@item.get("handlerName")
 }
-  - path: '/health/@serviceId'
+@if(healthCheck){  - path: '/health/@serviceId'
     method: 'get'
     exec:
       - health
-  - path: '/server/info'
+}
+@if(serverInfo){  - path: '/server/info'
     method: 'get'
     exec:
       - info
+}
 @if(prometheusMetrics){  - path: '/prometheus'
     method: 'get'
     exec:

diff --git a/light-rest-4j/src/main/resources/templates/rest/swagger/handlerYml.rocker.raw b/light-rest-4j/src/main/resources/templates/rest/swagger/handlerYml.rocker.raw
@@ -1,7 +1,7 @@
 @import java.util.Map
 @import java.util.List
 @import com.jsoniter.any.Any
-@args (String serviceId, String handlerPackage, List<Map<String, Any>> items, boolean prometheusMetrics)
+@args (String serviceId, String handlerPackage, List<Map<String, Any>> items, boolean prometheusMetrics, boolean healthCheck, boolean serverInfo)
 
 # Handler middleware chain configuration
 ---
@@ -75,14 +75,16 @@ paths:
       - default
       - @with (p = handlerPackage + ".") {@p}@item.get("handlerName")
 }
-  - path: '/health/@serviceId'
+@if(healthCheck){  - path: '/health/@serviceId'
     method: 'get'
     exec:
       - health
-  - path: '/server/info'
+}
+@if(serverInfo){  - path: '/server/info'
     method: 'get'
     exec:
       - info
+}
 @if(prometheusMetrics){  - path: '/prometheus'
     method: 'get'
     exec: