Add capability to use additionalModelTypeAnnotations (#89)

Author: miguelchico

README.md

@@ -53,10 +53,13 @@ To fine tune the configuration for each spec file, add the following entry to yo
 
 ```properties
 quarkus.openapi-generator.codegen.spec.petstore_json.base-package=org.acme.openapi
+quarkus.openapi-generator.codegen.spec.petstore_json.additional-model-type-annotations[email protected];@org.test.Bar
 ```
 
 If a base package name is not provided, it will be used the default `org.openapi.quarkus.<filename>`. For example, `org.openapi.quarkus.petstore_json`.
 
+Configuring `additional-model-type-annotations` will add all annotations to the generated model files (extra details can be found in [OpenApi Generator Doc](https://openapi-generator.tech/docs/generators/java/#config-options)).
+
 > **⚠️** Note that the file name`petstore_json`is used to configure the specific information for each spec. We follow the [Environment Variables Mapping Rules](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules) from Microprofile Configuration to sanitize the OpenAPI spec filename. Any non-alphabetic characters are replaced by an underscore `_`.
 
 Run `mvn compile` to generate your classes in `target/generated-sources/open-api-json` path:
@@ -270,14 +273,14 @@ public class PetResource {
   @Consumes(MediaType.APPLICATION_JSON)
   public Response customUpdatePet(@PathParam("id") long id, PetData petData) {
 
-    // Create a new instance of the Pet class generated by the quarkus-openapi-generator and 
+    // Create a new instance of the Pet class generated by the quarkus-openapi-generator and
     // populate accordingly.
     Pet pet = new Pet();
     pet.setId(id);
     applyDataToPet(pet, petData);
 
     // Execute the rest call using the generated client.
-    // The petstore.json open api spec stays that the "updatePet" operation is secured with the 
+    // The petstore.json open api spec stays that the "updatePet" operation is secured with the
     // security scheme "petstore_auth".
     petApi.updatePet(pet);
 
@@ -308,7 +311,7 @@ However, there are scenarios where we want to propagate the authorization token
 1) The user service `customUpdatePet` operation is invoked, and an authorization token is passed by the third party typically by using the HTTP `Authorization` header.
 2) The incoming authorization token is automatically passed along the PetApi `updatePet` operation execution according to the user-provided configuration.
 
-> **⚠️** When configured, the token propagation applies to all the operations secured with the same `securityScheme` in the same specification file. 
+> **⚠️** When configured, the token propagation applies to all the operations secured with the same `securityScheme` in the same specification file.
 
 ### Propagation flow configuration
 The token propagation can be used with type "oauth2" or "bearer" security schemes. Finally, considering that a given security scheme might be configured on a set of operations in the same specification file when configured, it'll apply to all these operations.

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/CodegenConfig.java

@@ -22,6 +22,7 @@ public class CodegenConfig {
     static final String BUILD_TIME_SPEC_PREFIX_FORMAT = "quarkus." + CODEGEN_TIME_CONFIG_PREFIX + ".spec.%s";
     private static final String BASE_PACKAGE_PROP_FORMAT = "%s.base-package";
     private static final String SKIP_FORM_MODEL_PROP_FORMAT = "%s.skip-form-model";
+    private static final String ADDITIONAL_MODEL_TYPE_ANNOTATIONS_PROP_FORMAT = "%s.additional-model-type-annotations";
 
     /**
      * OpenAPI Spec details for codegen configuration.
@@ -56,6 +57,10 @@ public static String getSkipFormModelPropertyName(final Path openApiFilePath) {
         return String.format(SKIP_FORM_MODEL_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
     }
 
+    public static String getAdditionalModelTypeAnnotationsPropertyName(final Path openApiFilePath) {
+        return String.format(ADDITIONAL_MODEL_TYPE_ANNOTATIONS_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
+    }
+
     /**
      * Gets the config prefix for a given OpenAPI file in the path.
      * For example, given a path like /home/luke/projects/petstore.json, the returned value is

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorCodeGenBase.java

@@ -1,6 +1,7 @@
 package io.quarkiverse.openapi.generator.deployment.codegen;
 
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.VERBOSE_PROPERTY_NAME;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getAdditionalModelTypeAnnotationsPropertyName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getBasePackagePropertyName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getSanitizedFileName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getSkipFormModelPropertyName;
@@ -79,6 +80,9 @@ protected void generate(final Config config, final Path openApiFilePath, final P
         config.getOptionalValue(getSkipFormModelPropertyName(openApiFilePath), String.class)
                 .ifPresent(generator::withSkipFormModelConfig);
 
+        config.getOptionalValue(getAdditionalModelTypeAnnotationsPropertyName(openApiFilePath), String.class)
+                .ifPresent(generator::withAdditionalModelTypeAnnotationsConfig);
+
         generator.generate(basePackage);
     }
 

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java

@@ -6,6 +6,7 @@
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
 import static java.util.Objects.requireNonNull;
+import static org.openapitools.codegen.languages.AbstractJavaCodegen.ADDITIONAL_MODEL_TYPE_ANNOTATIONS;
 
 import java.io.File;
 import java.nio.file.Path;
@@ -103,6 +104,19 @@ public OpenApiClientGeneratorWrapper withSkipFormModelConfig(final String skipFo
         return this;
     }
 
+    /**
+     * Sets the global 'additionalModelTypeAnnotations' setting. If not set this setting will default to empty.
+     *
+     * @param additionalModelTypeAnnotations the list of extra additional annotations to be included in a model
+     * @return this wrapper
+     */
+    public OpenApiClientGeneratorWrapper withAdditionalModelTypeAnnotationsConfig(final String additionalModelTypeAnnotations) {
+        if (additionalModelTypeAnnotations != null) {
+            this.configurator.addAdditionalProperty(ADDITIONAL_MODEL_TYPE_ANNOTATIONS, additionalModelTypeAnnotations);
+        }
+        return this;
+    }
+
     public List<File> generate(final String basePackage) {
         this.basePackage = basePackage;
         this.consolidatePackageNames();

deployment/src/main/resources/templates/additionalModelTypeAnnotations.qute

@@ -1 +1,3 @@
-{#for annon in m.additionalModelTypeAnnotations.orEmpty}{annon}{/for}
+{#for annon in additionalModelTypeAnnotations.orEmpty}
+{annon}
+{/for}

deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java

@@ -235,6 +235,31 @@ void verifyMultipartPojoGeneratedAndFieldsHaveAnnotations() throws URISyntaxExce
         });
     }
 
+    @Test
+    void verifyAdditionalModelTypeAnnotations() throws URISyntaxException {
+        List<File> generatedFiles = createGeneratorWrapper("petstore-openapi.json")
+                .withAdditionalModelTypeAnnotationsConfig("@org.test.Foo;@org.test.Bar")
+                .generate("org.additionalmodeltypeannotations");
+        assertFalse(generatedFiles.isEmpty());
+
+        generatedFiles.stream()
+                .filter(file -> file.getPath().matches(".*/model/.*.java"))
+                .forEach(file -> verifyModelAdditionalAnnotations(file));
+    }
+
+    private void verifyModelAdditionalAnnotations(File file) {
+        try {
+            CompilationUnit compilationUnit = StaticJavaParser.parse(file);
+            compilationUnit.findAll(ClassOrInterfaceDeclaration.class)
+                    .forEach(c -> {
+                        assertThat(c.getAnnotationByName("Foo")).isPresent();
+                        assertThat(c.getAnnotationByName("Bar")).isPresent();
+                    });
+        } catch (FileNotFoundException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+    }
+
     private List<File> generateRestClientFiles() throws URISyntaxException {
         OpenApiClientGeneratorWrapper generatorWrapper = createGeneratorWrapper("simple-openapi.json")
                 .withCircuitBreakerConfig(Map.of(

integration-tests/example-project/src/main/resources/application.properties

@@ -25,5 +25,6 @@ org.acme.openapi.simple.api.DefaultApi/byeGet/CircuitBreaker/successThreshold =
 
 
 quarkus.openapi-generator.codegen.spec.multipart_requests_yml.base-package=org.acme.openapi.multipart
+quarkus.openapi-generator.codegen.spec.multipart_requests_yml.additional-model-type-annotations=@io.quarkus.runtime.annotations.RegisterForReflection
 # By default the openapi-generator doesn't generate models for multipart requests
 quarkus.openapi-generator.codegen.spec.multipart_requests_yml.skip-form-model=false