Rest out (#13442)

CAMEL-19284: restdsl-openapi-generator - Add type and outType to Rest DSL
apache · Mar 11, 2024 · 93387e4 · 93387e4
1 parent 1957436
commit 93387e4
Show file tree

Hide file tree

Showing 22 changed files with 7,006 additions and 67 deletions.
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestDefinition.java
@@ -564,6 +564,17 @@ public RestDefinition produces(String mediaType) {
         return this;
     }
 
+    public RestDefinition type(String classType) {
+        // add to last verb
+        if (getVerbs().isEmpty()) {
+            throw new IllegalArgumentException(MISSING_VERB);
+        }
+
+        VerbDefinition verb = getVerbs().get(getVerbs().size() - 1);
+        verb.setType(classType);
+        return this;
+    }
+
     public RestDefinition type(Class<?> classType) {
         // add to last verb
         if (getVerbs().isEmpty()) {
@@ -576,6 +587,17 @@ public RestDefinition type(Class<?> classType) {
         return this;
     }
 
+    public RestDefinition outType(String classType) {
+        // add to last verb
+        if (getVerbs().isEmpty()) {
+            throw new IllegalArgumentException(MISSING_VERB);
+        }
+
+        VerbDefinition verb = getVerbs().get(getVerbs().size() - 1);
+        verb.setOutType(classType);
+        return this;
+    }
+
     public RestDefinition outType(Class<?> classType) {
         // add to last verb
         if (getVerbs().isEmpty()) {

diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_5.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_5.adoc
@@ -164,6 +164,10 @@ To
 
 We also renamed the `route-curcuit-breaker` console to `circuit-breaker`.
 
+=== camel-jbang
+
+The command `camel generate rest` have removed all the shorthand arguments `such as `-i -o` instead use the long names `--input --output`.
+
 === camel-jsonpath
 
 The `camel-jsonpath` will now work more similar as `camel-jq` when you specify a `resultType` and have a list of entities.

diff --git a/...-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeRestGenerator.java b/...-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/CodeRestGenerator.java
@@ -49,23 +49,23 @@
 @CommandLine.Command(name = "rest", description = "Generate REST DSL source code from OpenApi specification")
 public class CodeRestGenerator extends CamelCommand {
 
-    @CommandLine.Option(names = { "-i", "--input" }, required = true, description = "OpenApi specification file name")
+    @CommandLine.Option(names = { "--input" }, required = true, description = "OpenApi specification file name")
     private String input;
-    @CommandLine.Option(names = { "-o", "--output" }, description = "Output REST DSL file name")
+    @CommandLine.Option(names = { "--output" }, description = "Output REST DSL file name")
     private String output;
-    @CommandLine.Option(names = { "-t", "--type" }, description = "REST DSL type (YAML or XML)", defaultValue = "yaml")
+    @CommandLine.Option(names = { "--type" }, description = "REST DSL type (YAML or XML)", defaultValue = "yaml")
     private String type;
-    @CommandLine.Option(names = { "-r", "--routes" }, description = "Generate routes (only in YAML)")
+    @CommandLine.Option(names = { "--routes" }, description = "Generate routes (only in YAML)")
     private boolean generateRoutes;
-    @CommandLine.Option(names = { "-d", "--dto" }, description = "Generate Java Data Objects")
+    @CommandLine.Option(names = { "--dto" }, description = "Generate Java Data Objects")
     private boolean generateDataObjects;
-    @CommandLine.Option(names = { "-run", "--runtime" }, description = "Runtime (quarkus, or spring-boot)",
+    @CommandLine.Option(names = { "--runtime" }, description = "Runtime (quarkus, or spring-boot)",
                         defaultValue = "quarkus")
     private String runtime;
-    @CommandLine.Option(names = { "-p", "--package" }, description = "Package for generated Java models",
+    @CommandLine.Option(names = { "--package" }, description = "Package for generated Java models",
                         defaultValue = "model")
     private String packageName;
-    @CommandLine.Option(names = { "-v", "--openapi-version" }, description = "Openapi specification 3.0 or 3.1",
+    @CommandLine.Option(names = { "--openapi-version" }, description = "Openapi specification 3.0 or 3.1",
                         defaultValue = "3.0")
     private String openApiVersion = "3.0";
 
@@ -93,9 +93,13 @@ public Integer doCall() throws Exception {
         try (CamelContext context = new DefaultCamelContext()) {
             String text = null;
             if ("yaml".equalsIgnoreCase(type)) {
-                text = RestDslGenerator.toYaml(doc).generate(context, generateRoutes);
+                text = RestDslGenerator.toYaml(doc)
+                        .withDtoPackageName(generateDataObjects ? packageName : null)
+                        .generate(context, generateRoutes);
             } else if ("xml".equalsIgnoreCase(type)) {
-                text = RestDslGenerator.toXml(doc).generate(context);
+                text = RestDslGenerator.toXml(doc)
+                        .withDtoPackageName(generateDataObjects ? packageName : null)
+                        .generate(context);
             }
             if (text != null) {
                 if (output == null) {

diff --git a/...l-openapi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateMojo.java b/...l-openapi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateMojo.java
@@ -49,6 +49,10 @@ public class GenerateMojo extends AbstractGenerateMojo {
 
     @Override
     public void execute() throws MojoExecutionException {
+        execute(false);
+    }
+
+    protected void execute(boolean dto) throws MojoExecutionException {
         if (skip) {
             return;
         }
@@ -87,6 +91,13 @@ public void execute() throws MojoExecutionException {
         if (ObjectHelper.isNotEmpty(packageName)) {
             generator.withPackageName(packageName);
         }
+        if (dto) {
+            if (modelPackage != null) {
+                generator.withDtoPackageName(modelPackage);
+            } else {
+                generator.withDtoPackageName(packageName);
+            }
+        }
 
         if (ObjectHelper.isNotEmpty(destinationGenerator)) {
             final DestinationGenerator destinationGeneratorObject = createDestinationGenerator();

diff --git a/...pi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateWithDtoMojo.java b/...pi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateWithDtoMojo.java
@@ -30,7 +30,7 @@ public void execute() throws MojoExecutionException {
         if (skip) {
             return;
         }
-        super.execute();
+        super.execute(true);
 
         generateDto("java");
     }

diff --git a/...penapi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateXmlMojo.java b/...penapi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateXmlMojo.java
@@ -47,6 +47,10 @@ public class GenerateXmlMojo extends AbstractGenerateMojo {
 
     @Override
     public void execute() throws MojoExecutionException {
+        execute(false);
+    }
+
+    protected void execute(boolean dto) throws MojoExecutionException {
         if (skip) {
             return;
         }
@@ -78,6 +82,11 @@ public void execute() throws MojoExecutionException {
         if (ObjectHelper.isNotEmpty(filterOperation)) {
             generator.withOperationFilter(filterOperation);
         }
+        if (dto) {
+            if (modelPackage != null) {
+                generator.withDtoPackageName(modelPackage);
+            }
+        }
 
         if (ObjectHelper.isNotEmpty(destinationGenerator)) {
             final DestinationGenerator destinationGeneratorObject = createDestinationGenerator();

diff --git a/...plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateXmlWithDtoMojo.java b/...plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateXmlWithDtoMojo.java
@@ -30,7 +30,7 @@ public void execute() throws MojoExecutionException {
         if (skip) {
             return;
         }
-        super.execute();
+        super.execute(true);
 
         generateDto("java");
     }

diff --git a/...enapi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateYamlMojo.java b/...enapi-plugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateYamlMojo.java
@@ -44,6 +44,10 @@ public class GenerateYamlMojo extends AbstractGenerateMojo {
 
     @Override
     public void execute() throws MojoExecutionException {
+        execute(false);
+    }
+
+    protected void execute(boolean dto) throws MojoExecutionException {
         if (skip) {
             return;
         }
@@ -71,6 +75,11 @@ public void execute() throws MojoExecutionException {
         if (ObjectHelper.isNotEmpty(filterOperation)) {
             generator.withOperationFilter(filterOperation);
         }
+        if (dto) {
+            if (modelPackage != null) {
+                generator.withDtoPackageName(modelPackage);
+            }
+        }
 
         if (ObjectHelper.isNotEmpty(destinationGenerator)) {
             final DestinationGenerator destinationGeneratorObject = createDestinationGenerator();

diff --git a/...lugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateYamlWithDtoMojo.java b/...lugin/src/main/java/org/apache/camel/maven/generator/openapi/GenerateYamlWithDtoMojo.java
@@ -30,7 +30,7 @@ public void execute() throws MojoExecutionException {
         if (skip) {
             return;
         }
-        super.execute();
+        super.execute(true);
 
         generateDto("java");
     }