Issue OpenAPITools#795: Add microprofile OpenAPI annotations for quar…

…kus library in JaxRsSpec
miguelborges99 · May 2, 2023 · d2ce117 · d2ce117
1 parent 998fd0e
commit d2ce117
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 17 deletions.
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
@@ -628,6 +628,8 @@ void generateApis(List<File> files, List<OperationsMap> allOperations, List<Mode
                 operation.put("importPath", config.toApiImport(tag));
                 operation.put("classFilename", config.toApiFilename(tag));
                 operation.put("strictSpecBehavior", config.isStrictSpecBehavior());
+                Optional.ofNullable(openAPI.getInfo()).map(Info::getLicense).ifPresent(license -> operation.put("license", license));
+                Optional.ofNullable(openAPI.getInfo()).map(Info::getContact).ifPresent(contact -> operation.put("contact", contact));
 
                 if (allModels == null || allModels.isEmpty()) {
                     operation.put("hasModel", false);

diff --git a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/api.mustache b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/api.mustache
@@ -36,7 +36,15 @@ import java.util.List;
 {{#useBeanValidation}}import {{javaxPackage}}.validation.constraints.*;
 import {{javaxPackage}}.validation.Valid;{{/useBeanValidation}}
 
-{{#useMicroProfileOpenAPIAnnotations}}@OpenAPIDefinition(info = @Info(title = "{{{tagName}}}", version="{{{version}}}", description="{{{tagDescription}}}")){{/useMicroProfileOpenAPIAnnotations}}{{#useSwaggerAnnotations}}
+{{#useMicroProfileOpenAPIAnnotations}}@OpenAPIDefinition(
+   info = @Info(
+        title = "{{{tagName}}}", version="{{{version}}}", description="{{{tagDescription}}}"{{#license}},
+        license = @License(name = "{{{name}}}", url = "{{{url}}}"){{/license}}{{#contact}},
+        contact = @Contact(name = "{{{name}}}", email = "{{{email}}}"){{/contact}}
+   ),
+   tags = {
+        @Tag(name="{{{tagName}}}", description="{{{tagDescription}}}")
+   }){{/useMicroProfileOpenAPIAnnotations}}{{#useSwaggerAnnotations}}
 @Api(description = "the {{{baseName}}} API"){{/useSwaggerAnnotations}}
 @Path("{{commonPath}}"){{#hasConsumes}}
 @Consumes({ {{#consumes}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/consumes}} }){{/hasConsumes}}{{#hasProduces}}

diff --git a/...enapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/apiInterface.mustache b/...enapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/apiInterface.mustache
@@ -21,8 +21,8 @@
     @ApiResponses(value = { {{#responses}}
         @ApiResponse(code = {{{code}}}, message = "{{{message}}}", response = {{{baseType}}}.class{{#returnContainer}}, responseContainer = "{{{.}}}"{{/returnContainer}}){{^-last}},{{/-last}}{{/responses}} }){{/useSwaggerAnnotations}}{{#useMicroProfileOpenAPIAnnotations}}
     {{#hasAuthMethods}}@SecurityRequirements(value={
-        {{#authMethods}}{{#isOAuth}}@SecurityRequirement(name = "{{name}}", scopes = { {{#scopes}} "{{scope}}"{{^-last}},{{/-last}} {{/scopes}} }){{^-last}},{{/-last}}{{/isOAuth}}{{^isOAuth}}
-            @SecurityRequirement(name = "{{name}}"){{^-last}},{{/-last}}{{/isOAuth}}{{/authMethods}} }){{/hasAuthMethods}}
+        {{#authMethods}}{{#isOAuth}}@SecurityRequirement(name = "{{name}}", scopes = { {{#scopes}} "{{scope}}"{{^-last}},{{/-last}} {{/scopes}} }){{^-last}},{{/-last}}{{/isOAuth}}{{^isOAuth}}     @SecurityRequirement(name = "{{name}}"){{^-last}},{{/-last}}{{/isOAuth}}
+   {{/authMethods}} }){{/hasAuthMethods}}
     @Operation(operationId = "{{{operationId}}}", summary = "{{{summary}}}", description = "{{{notes}}}")
     {{#vendorExtensions.x-tags}}@Tag(name="{{tag}}"){{^-last}}, {{/-last}}{{/vendorExtensions.x-tags}}{{#hasProduces}}
     @APIResponses(value = { {{#responses}}

diff --git a/.../openapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/apiMethod.mustache b/.../openapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/apiMethod.mustache
@@ -22,8 +22,8 @@
         @ApiResponse(code = {{{code}}}, message = "{{{message}}}", response = {{{baseType}}}.class{{#containerType}}, responseContainer = "{{{.}}}"{{/containerType}}){{^-last}},{{/-last}}{{/responses}}
     }){{/useSwaggerAnnotations}}{{#useMicroProfileOpenAPIAnnotations}}
     {{#hasAuthMethods}}@SecurityRequirements(value={
-    {{#authMethods}}{{#isOAuth}}@SecurityRequirement(name = "{{name}}", scopes = { {{#scopes}} "{{scope}}"{{^-last}},{{/-last}} {{/scopes}} }){{^-last}},{{/-last}}{{/isOAuth}}{{^isOAuth}}
-        @SecurityRequirement(name = "{{name}}"){{^-last}},{{/-last}}{{/isOAuth}}{{/authMethods}} }){{/hasAuthMethods}}
+        {{#authMethods}}{{#isOAuth}}@SecurityRequirement(name = "{{name}}", scopes = { {{#scopes}} "{{scope}}"{{^-last}},{{/-last}} {{/scopes}} }){{^-last}},{{/-last}}{{/isOAuth}}{{^isOAuth}}     @SecurityRequirement(name = "{{name}}"){{^-last}},{{/-last}}{{/isOAuth}}
+   {{/authMethods}} }){{/hasAuthMethods}}
     @Operation(operationId = "{{{operationId}}}", summary = "{{{summary}}}", description = "{{{notes}}}")
     {{#vendorExtensions.x-tags}}@Tag(name="{{tag}}"){{^-last}}, {{/-last}}{{/vendorExtensions.x-tags}}{{#hasProduces}}
         @APIResponses(value = { {{#responses}}

diff --git a/...tor/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java b/...tor/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java
@@ -825,18 +825,21 @@ public void generateSpecInterfaceWithMicroprofileOpenApiAnnotations() throws Exc
         //And the generated interfaces contains CompletionStage
         TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/PetApi.java");
         assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/PetApi.java"),
-                "@OpenAPIDefinition(info = @Info(title = \"pet\", version=\"1.0.0\", description=\"Everything about your Pets\"))"
-        );
+                "@OpenAPIDefinition(\n" +
+                        "   info = @Info(\n" +
+                        "        title = \"pet\", version=\"1.0.0\", description=\"Everything about your Pets\",");
 
         TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/StoreApi.java");
         assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/StoreApi.java"),
-                "@OpenAPIDefinition(info = @Info(title = \"store\", version=\"1.0.0\", description=\"Access to Petstore orders\"))"
-        );
+                "@OpenAPIDefinition(\n" +
+                        "   info = @Info(\n" +
+                        "        title = \"store\", version=\"1.0.0\", description=\"Access to Petstore orders\",");
 
         TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/UserApi.java");
         assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/UserApi.java"),
-                "@OpenAPIDefinition(info = @Info(title = \"user\", version=\"1.0.0\", description=\"Operations about user\"))"
-        );
+                "@OpenAPIDefinition(\n" +
+                        "   info = @Info(\n" +
+                        "        title = \"user\", version=\"1.0.0\", description=\"Operations about user\",");
     }
 
     @Test
@@ -868,17 +871,20 @@ public void generateSpecNonInterfaceWithMicroprofileOpenApiAnnotations() throws
         //And the generated interfaces contains CompletionStage
         TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/PetApi.java");
         assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/PetApi.java"),
-                "@OpenAPIDefinition(info = @Info(title = \"pet\", version=\"1.0.0\", description=\"Everything about your Pets\"))"
-        );
+                "@OpenAPIDefinition(\n" +
+                        "   info = @Info(\n" +
+                        "        title = \"pet\", version=\"1.0.0\", description=\"Everything about your Pets\",");
 
         TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/StoreApi.java");
         assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/StoreApi.java"),
-                "@OpenAPIDefinition(info = @Info(title = \"store\", version=\"1.0.0\", description=\"Access to Petstore orders\"))"
-        );
+                "@OpenAPIDefinition(\n" +
+                        "   info = @Info(\n" +
+                        "        title = \"store\", version=\"1.0.0\", description=\"Access to Petstore orders\",");
 
         TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/UserApi.java");
         assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/UserApi.java"),
-                "@OpenAPIDefinition(info = @Info(title = \"user\", version=\"1.0.0\", description=\"Operations about user\"))"
-        );
+                "@OpenAPIDefinition(\n" +
+                        "   info = @Info(\n" +
+                        "        title = \"user\", version=\"1.0.0\", description=\"Operations about user\",");
     }
 }