[java] jaxrs (all) add usetags option (#6130)

* Adds "useTags" option to all jaxrs code generators (AbstractJAXRSServerCodegen):
  - jaxrs-jersey
  - jaxrs-spec
  - jaxrs-cxf-cdi
  - jaxrs-resteasy
  - jaxrs-cxf
  - jaxrs-cxf-extended
  - java-msf4j
  - jaxrs-resteasy-eap
* jaxrs-spec
  - Changed handling of root paths: e.g "/:", "/{id}:" to simplify code and create a more consistent behaviour
    -- old: use tag for classname
    -- new: use tag only if useTags is enabled, use "DefaultApi" if not
* @path class level annotation
  - for all generators above and the microprofile generator (uses same jaxrs postprocessing)
  - extended the "commonPath" to contain more than only the root path if possible
  - e.g. "/group1/subgroup1/op1" -> "/group1/subgroup1" is moved to class level annotation

Author: PhilippParis

docs/generators/java-msf4j.md

@@ -51,6 +51,7 @@ sidebar_label: java-msf4j
 |sourceFolder|source folder for generated code| |src/main/java|
 |title|a title describing the application| |OpenAPI Server|
 |useBeanValidation|Use BeanValidation API annotations| |true|
+|useTags|use tags for creating interface and controller classnames| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 
 ## IMPORT MAPPING

docs/generators/jaxrs-cxf-cdi.md

@@ -57,6 +57,7 @@ sidebar_label: jaxrs-cxf-cdi
 |title|a title describing the application| |OpenAPI Server|
 |useBeanValidation|Use BeanValidation API annotations| |true|
 |useSwaggerAnnotations|Whether to generate Swagger annotations.| |true|
+|useTags|use tags for creating interface and controller classnames| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 
 ## IMPORT MAPPING

docs/generators/jaxrs-cxf-extended.md

@@ -71,6 +71,7 @@ sidebar_label: jaxrs-cxf-extended
 |useSpringAnnotationConfig|Use Spring Annotation Config| |false|
 |useSwaggerFeature|Use Swagger Feature| |false|
 |useSwaggerUI|Use Swagger UI| |false|
+|useTags|use tags for creating interface and controller classnames| |true|
 |useWadlFeature|Use WADL Feature| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 

docs/generators/jaxrs-cxf.md

@@ -66,6 +66,7 @@ sidebar_label: jaxrs-cxf
 |useSpringAnnotationConfig|Use Spring Annotation Config| |false|
 |useSwaggerFeature|Use Swagger Feature| |false|
 |useSwaggerUI|Use Swagger UI| |false|
+|useTags|use tags for creating interface and controller classnames| |true|
 |useWadlFeature|Use WADL Feature| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 

docs/generators/jaxrs-resteasy-eap.md

@@ -52,6 +52,7 @@ sidebar_label: jaxrs-resteasy-eap
 |title|a title describing the application| |OpenAPI Server|
 |useBeanValidation|Use BeanValidation API annotations| |true|
 |useSwaggerFeature|Use dynamic Swagger generator| |false|
+|useTags|use tags for creating interface and controller classnames| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 
 ## IMPORT MAPPING

docs/generators/jaxrs-resteasy.md

@@ -51,6 +51,7 @@ sidebar_label: jaxrs-resteasy
 |sourceFolder|source folder for generated code| |src/main/java|
 |title|a title describing the application| |OpenAPI Server|
 |useBeanValidation|Use BeanValidation API annotations| |true|
+|useTags|use tags for creating interface and controller classnames| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 
 ## IMPORT MAPPING

docs/generators/jaxrs-spec.md

@@ -57,6 +57,7 @@ sidebar_label: jaxrs-spec
 |title|a title describing the application| |OpenAPI Server|
 |useBeanValidation|Use BeanValidation API annotations| |true|
 |useSwaggerAnnotations|Whether to generate Swagger annotations.| |true|
+|useTags|use tags for creating interface and controller classnames| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 
 ## IMPORT MAPPING

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaJAXRSServerCodegen.java

@@ -17,9 +17,11 @@
 
 package org.openapitools.codegen.languages;
 
+import com.google.common.annotations.VisibleForTesting;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
+import org.apache.commons.lang3.StringUtils;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
 import org.openapitools.codegen.utils.URLPathUtils;
@@ -30,10 +32,10 @@
 import java.net.URL;
 import java.util.*;
 
-import static org.openapitools.codegen.utils.StringUtils.camelize;
-
 public abstract class AbstractJavaJAXRSServerCodegen extends AbstractJavaCodegen implements BeanValidationFeatures {
     public static final String SERVER_PORT = "serverPort";
+    public static final String USE_TAGS = "useTags";
+
     /**
      * Name of the sub-directory in "src/main/resource" where to find the
      * Mustache template for the JAX-RS Codegen.
@@ -43,7 +45,9 @@ public abstract class AbstractJavaJAXRSServerCodegen extends AbstractJavaCodegen
     protected String testResourcesFolder = "src/test/resources";
     protected String title = "OpenAPI Server";
     protected String serverPort = "8080";
+
     protected boolean useBeanValidation = true;
+    protected boolean useTags = false;
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AbstractJavaJAXRSServerCodegen.class);
 
@@ -72,6 +76,7 @@ public AbstractJavaJAXRSServerCodegen() {
         cliOptions.add(new CliOption("title", "a title describing the application").defaultValue(title));
         cliOptions.add(CliOption.newBoolean(USE_BEANVALIDATION, "Use BeanValidation API annotations",useBeanValidation));
         cliOptions.add(new CliOption(SERVER_PORT, "The port on which the server should be started").defaultValue(serverPort));
+        cliOptions.add(CliOption.newBoolean(USE_TAGS, "use tags for creating interface and controller classnames"));
     }
 
 
@@ -93,11 +98,32 @@ public void processOpts() {
         }
 
         if (additionalProperties.containsKey(USE_BEANVALIDATION)) {
-            this.setUseBeanValidation(convertPropertyToBoolean(USE_BEANVALIDATION));
+            setUseBeanValidation(convertPropertyToBoolean(USE_BEANVALIDATION));
+        }
+
+        if (additionalProperties.containsKey(USE_TAGS)) {
+            setUseTags(convertPropertyToBoolean(USE_TAGS));
         }
 
         writePropertyBack(USE_BEANVALIDATION, useBeanValidation);
+    }
 
+    @Override
+    public void addOperationToGroup(String tag, String resourcePath, Operation operation, CodegenOperation co, Map<String, List<CodegenOperation>> operations) {
+        final String basePath = StringUtils.substringBefore(StringUtils.removeStart(resourcePath, "/"), "/");
+        if (!StringUtils.isEmpty(basePath)) {
+            co.subresourceOperation = !co.path.isEmpty();
+        }
+        if (useTags) {
+            super.addOperationToGroup(tag, resourcePath, operation, co, operations);
+        } else {
+            co.baseName = basePath;
+            if (StringUtils.isEmpty(co.baseName) || StringUtils.containsAny(co.baseName, "{", "}")) {
+                co.baseName = "default";
+            }
+            final List<CodegenOperation> opList = operations.computeIfAbsent(co.baseName, k -> new ArrayList<>());
+            opList.add(co);
+        }
     }
 
     @Override
@@ -151,9 +177,8 @@ public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> o
     static Map<String, Object> jaxrsPostProcessOperations(Map<String, Object> objs) {
         @SuppressWarnings("unchecked")
         Map<String, Object> operations = (Map<String, Object>) objs.get("operations");
+        String commonPath = null;
         if (operations != null) {
-            String commonBaseName = null;
-            boolean baseNameEquals = true;
             @SuppressWarnings("unchecked")
             List<CodegenOperation> ops = (List<CodegenOperation>) operations.get("operation");
             for (CodegenOperation operation : ops) {
@@ -223,24 +248,18 @@ static Map<String, Object> jaxrsPostProcessOperations(Map<String, Object> objs)
                 } else if ("map".equals(operation.returnContainer)) {
                     operation.returnContainer = "Map";
                 }
-                
-                if(commonBaseName == null) {
-                    commonBaseName = operation.baseName;
-                } else if(!commonBaseName.equals(operation.baseName)) {
-                    baseNameEquals = false;
+
+                if (commonPath == null) {
+                    commonPath = operation.path;
+                } else {
+                    commonPath = getCommonPath(commonPath, operation.path);
                 }
             }
-            if(baseNameEquals) {
-                objs.put("commonPath", commonBaseName);
-            } else {
-                for (CodegenOperation operation : ops) {
-                    if(operation.baseName != null) {
-                        operation.path = "/" + operation.baseName + operation.path;
-                        operation.baseName = null;
-                    }
-                }
-                objs.put("commonPath", null);
+            for (CodegenOperation co : ops) {
+                co.path = StringUtils.removeStart(co.path, commonPath);
+                co.subresourceOperation = co.path.length() > 1;
             }
+            objs.put("commonPath", "/".equals(commonPath) ? StringUtils.EMPTY : commonPath);
         }
         return objs;
     }
@@ -251,7 +270,7 @@ public String toApiName(final String name) {
         if (computed.length() > 0) {
             computed = sanitizeName(computed);
         }
-         return super.toApiName(computed);
+        return super.toApiName(computed);
     }
 
     @Override
@@ -273,6 +292,19 @@ public String apiFilename(String templateName, String tag) {
         return result;
     }
 
+    private static String getCommonPath(String path1, String path2) {
+        final String[] parts1 = StringUtils.split(path1, "/");
+        final String[] parts2 = StringUtils.split(path2, "/");
+        StringBuilder builder = new StringBuilder();
+        for (int i = 0; i < Math.min(parts1.length, parts2.length); i++) {
+            if (!parts1[i].equals(parts2[i])) {
+                break;
+            }
+            builder.append("/").append(parts1[i]);
+        }
+        return builder.toString();
+    }
+
     private String implFileFolder(String output) {
         return outputFolder + "/" + output + "/" + apiPackage().replace('.', '/');
     }
@@ -281,5 +313,8 @@ public void setUseBeanValidation(boolean useBeanValidation) {
         this.useBeanValidation = useBeanValidation;
     }
 
-
+    @VisibleForTesting
+    public void setUseTags(boolean useTags) {
+        this.useTags = useTags;
+    }
 }

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaCXFServerCodegen.java

@@ -72,13 +72,15 @@ public JavaCXFServerCodegen() {
         super();
 
         supportsInheritance = true;
+        useTags = true;
 
         artifactId = "openapi-cxf-server";
 
         outputFolder = "generated-code/JavaJaxRS-CXF";
 
         // clioOptions default redifinition need to be updated
         updateOption(CodegenConstants.ARTIFACT_ID, this.getArtifactId());
+        updateOption(USE_TAGS, String.valueOf(true));
 
         apiTemplateFiles.put("apiServiceImpl.mustache", ".java");
 
@@ -234,12 +236,6 @@ public String getName() {
         return "jaxrs-cxf";
     }
 
-    @Override
-    public void addOperationToGroup(String tag, String resourcePath, Operation operation, CodegenOperation co, Map<String, List<CodegenOperation>> operations) {
-        super.addOperationToGroup(tag, resourcePath, operation, co, operations);
-        co.subresourceOperation = !co.path.isEmpty();
-    }
-
     @Override
     public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
         super.postProcessModelProperty(model, property);

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

@@ -17,19 +17,14 @@
 
 package org.openapitools.codegen.languages;
 
-import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Schema;
 import org.apache.commons.lang3.StringUtils;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.meta.features.DocumentationFeature;
 
 import java.io.File;
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Map;
 
-import static org.openapitools.codegen.utils.StringUtils.camelize;
-
 public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 
     public static final String INTERFACE_ONLY = "interfaceOnly";
@@ -54,8 +49,6 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
     private boolean useJackson = false;
     private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
 
-    private String primaryResourceName;
-
     public JavaJAXRSSpecServerCodegen() {
         super();
 
@@ -240,41 +233,6 @@ public void setOpenApiSpecFileLocation(String location) {
         this.openApiSpecFileLocation = location;
     }
 
-    @Override
-    public void addOperationToGroup(String tag, String resourcePath, Operation operation, CodegenOperation co, Map<String, List<CodegenOperation>> operations) {
-        String basePath = resourcePath;
-        if (basePath.startsWith("/")) {
-            basePath = basePath.substring(1);
-        }
-        int pos = basePath.indexOf("/");
-        if (pos > 0) {
-            basePath = basePath.substring(0, pos);
-        }
-
-        String operationKey = basePath;
-        if (StringUtils.isEmpty(basePath)) {
-            basePath = tag;
-            operationKey = "";
-            primaryResourceName = tag;
-        } else if (basePath.matches("\\{.*\\}")) {
-            basePath = tag;
-            operationKey = "";
-            co.subresourceOperation = true;
-        } else {
-            if (co.path.startsWith("/" + basePath)) {
-                co.path = co.path.substring(("/" + basePath).length());
-            }
-            co.subresourceOperation = !co.path.isEmpty();
-        }
-        List<CodegenOperation> opList = operations.get(operationKey);
-        if (opList == null || opList.isEmpty()) {
-            opList = new ArrayList<CodegenOperation>();
-            operations.put(operationKey, opList);
-        }
-        opList.add(co);
-        co.baseName = basePath;
-    }
-
     @Override
     public CodegenModel fromModel(String name, Schema model) {
         CodegenModel codegenModel = super.fromModel(name, model);
@@ -302,16 +260,4 @@ public String getHelp() {
         return "Generates a Java JAXRS Server according to JAXRS 2.0 specification.";
     }
 
-    @Override
-    public String toApiName(final String name) {
-        String computed = name;
-        if (computed.length() == 0) {
-            if (primaryResourceName == null) {
-                return "DefaultApi";
-            }
-            return primaryResourceName + "Api";
-        }
-        computed = sanitizeName(computed);
-        return camelize(computed) + "Api";
-    }
 }