Merge pull request #327 from mcruzdev/issue-326

EricWittmann · web-flow · commit 59d7c716c4c1 · 2025-03-24T15:57:52.000-04:00
Add application level annotation using CodegenInfo
diff --git a/core/src/main/java/io/apicurio/hub/api/codegen/OpenApi2JaxRs.java b/core/src/main/java/io/apicurio/hub/api/codegen/OpenApi2JaxRs.java
@@ -285,8 +285,8 @@ protected void generateAll(CodegenInfo info, StringBuilder log, ZipOutputStream
         }
 
         if (!this.updateOnly) {
-            String appFileName = javaPackageToZipPath(this.settings.javaPackage) + "JaxRsApplication.java";
-            String jaxRsApp = generateJaxRsApplication();
+            String appFileName = javaPackageToZipPath(this.settings.javaPackage) + getMainClassName() + ".java";
+            String jaxRsApp = generateJaxRsApplication(info);
             if (jaxRsApp != null) {
                 log.append("Generating " + appFileName + "\r\n");
                 zipOutput.putNextEntry(new ZipEntry(appFileName));
@@ -409,6 +409,25 @@ protected String getContextRoot(Document document) {
         return null;
     }
 
+    protected String getMainClassName() {
+        return "JaxRsApplication";
+    }
+    protected JavaClassSource generateApplicationClassSource(String topLevelPackage, CodegenInfo info) {
+      return Roaster.create(JavaClassSource.class)
+                      .setPackage(this.settings.javaPackage)
+                      .setPublic()
+                      .setName(getMainClassName())
+                      .setSuperType(String.format("%s.ws.rs.core.Application", topLevelPackage))
+                      .getJavaDoc()
+                      .setFullText("The JAX-RS application.")
+                      .getOrigin()
+                      .addAnnotation(String.format("%s.enterprise.context.ApplicationScoped", topLevelPackage))
+                      .getOrigin()
+                      .addAnnotation(String.format("%s.ws.rs.ApplicationPath", topLevelPackage))
+                      .setStringValue("/")
+                      .getOrigin();
+    }
+
     /**
      * Pre-process the document to modify it in the following ways:
      *
@@ -471,20 +490,8 @@ protected String generatePomXml(CodegenInfo info) throws IOException {
     /**
      * Generates the JaxRsApplication Java class.
      */
-    protected String generateJaxRsApplication(String topLevelPackage) {
-        JavaClassSource jaxRsApp = Roaster.create(JavaClassSource.class)
-                .setPackage(this.settings.javaPackage)
-                .setPublic()
-                .setName("JaxRsApplication")
-                .setSuperType(String.format("%s.ws.rs.core.Application", topLevelPackage))
-                .getJavaDoc()
-                .setFullText("The JAX-RS application.")
-                .getOrigin()
-                .addAnnotation(String.format("%s.enterprise.context.ApplicationScoped", topLevelPackage))
-                .getOrigin()
-                .addAnnotation(String.format("%s.ws.rs.ApplicationPath", topLevelPackage))
-                .setStringValue("/")
-                .getOrigin();
+    protected String generateJaxRsApplication(String topLevelPackage, CodegenInfo info) {
+        JavaClassSource jaxRsApp = generateApplicationClassSource(topLevelPackage, info);
 
         sortImports(jaxRsApp);
 
@@ -494,8 +501,8 @@ protected String generateJaxRsApplication(String topLevelPackage) {
     /**
      * Generates the JaxRsApplication java class.
      */
-    protected String generateJaxRsApplication() {
-        return generateJaxRsApplication("jakarta");
+    protected String generateJaxRsApplication(CodegenInfo info) {
+        return generateJaxRsApplication("jakarta", info);
     }
 
     void sortImports(Importer<?> javaSource) {
diff --git a/core/src/main/java/io/apicurio/hub/api/codegen/OpenApi2Quarkus.java b/core/src/main/java/io/apicurio/hub/api/codegen/OpenApi2Quarkus.java
@@ -19,7 +19,6 @@
 import java.io.IOException;
 import java.io.UncheckedIOException;
 import java.net.URL;
-import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
@@ -28,6 +27,8 @@
 import org.apache.commons.io.IOUtils;
 
 import io.apicurio.hub.api.codegen.beans.CodegenInfo;
+import org.jboss.forge.roaster.Roaster;
+import org.jboss.forge.roaster.model.source.JavaClassSource;
 
 
 /**
@@ -75,13 +76,20 @@ protected void generateAll(CodegenInfo info, StringBuilder log, ZipOutputStream
         }
     }
 
-    /**
-     * @see io.apicurio.hub.api.codegen.OpenApi2JaxRs#generateJaxRsApplication()
-     */
     @Override
-    protected String generateJaxRsApplication() {
-        // Don't need one of these for Quarkus.
-        return null;
+    protected JavaClassSource generateApplicationClassSource(String topLevelPackage, CodegenInfo info) {
+
+       return Roaster.create(JavaClassSource.class)
+             .setName(getMainClassName())
+             .getJavaDoc()
+             .setFullText(info.getName() + " " + info.getVersion())
+             .getOrigin()
+             .setSuperType("jakarta.ws.rs.core.Application")
+             .setPackage(this.settings.javaPackage)
+             .setPublic()
+             .addAnnotation("org.eclipse.microprofile.openapi.annotations.OpenApiDefinition")
+             .setLiteralValue("info", String.format("@org.eclipse.microprofile.openapi.annotations.info.Info(title = \"%s\", version = \"%s\")", info.getName(), info.getVersion()))
+             .getOrigin();
     }
 
     @Override
@@ -118,4 +126,8 @@ protected URL getQuarkusResource(String name) {
         return getClass().getResource("quarkus/" + name);
     }
 
+    @Override
+    protected String getMainClassName() {
+        return "Application";
+    }
 }
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-full-different-ns/generated-api-11/src/main/java/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-full-different-ns/generated-api-11/src/main/java/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Beer API 1.0.0
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Beer API", version = "1.0.0"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-full-different-ns/generated-api-17/src/main/java/my/other/pkg/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-full-different-ns/generated-api-17/src/main/java/my/other/pkg/Application.java
@@ -0,0 +1,10 @@
+package my.other.pkg;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Apicurio Registry API [v2] 2.4.x
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Apicurio Registry API [v2]", version = "2.4.x"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-full-different-ns/generated-api-21/src/main/java/my/other/pkg/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-full-different-ns/generated-api-21/src/main/java/my/other/pkg/Application.java
@@ -0,0 +1,10 @@
+package my.other.pkg;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Apicurio Registry API [v2] 2.4.x
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Apicurio Registry API [v2]", version = "2.4.x"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-full/generated-api-17/src/main/java/org/example/api/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-full/generated-api-17/src/main/java/org/example/api/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Beer API 1.0.0
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Beer API", version = "1.0.0"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-full/generated-api-21/src/main/java/org/example/api/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-full/generated-api-21/src/main/java/org/example/api/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Beer API 1.0.0
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Beer API", version = "1.0.0"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-github/generated-api-17/src/main/java/org/example/api/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-github/generated-api-17/src/main/java/org/example/api/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * GitHub v3 REST API 0.0.3
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "GitHub v3 REST API", version = "0.0.3"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-github/generated-api-21/src/main/java/org/example/api/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-github/generated-api-21/src/main/java/org/example/api/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * GitHub v3 REST API 0.0.3
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "GitHub v3 REST API", version = "0.0.3"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-strimzi-kafka-bridge/generated-api-17/src/main/java/org/example/api/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-strimzi-kafka-bridge/generated-api-17/src/main/java/org/example/api/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Strimzi Kafka Bridge API Reference 0.1.0
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Strimzi Kafka Bridge API Reference", version = "0.1.0"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
diff --git a/core/src/test/resources/OpenApi2QuarkusTest/_expected-strimzi-kafka-bridge/generated-api-21/src/main/java/org/example/api/Application.java b/core/src/test/resources/OpenApi2QuarkusTest/_expected-strimzi-kafka-bridge/generated-api-21/src/main/java/org/example/api/Application.java
@@ -0,0 +1,10 @@
+package org.example.api;
+
+import org.eclipse.microprofile.openapi.annotations.OpenApiDefinition;
+
+/**
+ * Strimzi Kafka Bridge API Reference 0.1.0
+ */
+@OpenApiDefinition(info = @org.eclipse.microprofile.openapi.annotations.info.Info(title = "Strimzi Kafka Bridge API Reference", version = "0.1.0"))
+public class Application extends jakarta.ws.rs.core.Application {
+}
