Fix #11570 by ensuring tags at the class level match tags at the method level (#13434)

Author: GregDThomas

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

@@ -44,6 +44,7 @@
 import java.util.regex.Matcher;
 import java.util.stream.Collectors;
 
+import io.swagger.v3.oas.models.tags.Tag;
 import org.apache.commons.lang3.tuple.Pair;
 import org.openapitools.codegen.CliOption;
 import org.openapitools.codegen.CodegenConstants;
@@ -802,7 +803,13 @@ public void setReturnContainer(final String returnContainer) {
 
                 handleImplicitHeaders(operation);
             }
-            objs.put("tagDescription", ops.get(0).tags.get(0).getDescription());
+            // The tag for the controller is the first tag of the first operation
+            final CodegenOperation firstOperation = ops.get(0);
+            final Tag firstTag = firstOperation.tags.get(0);
+            final String firstTagName = firstTag.getName();
+            // But use a sensible tag name if there is none
+            objs.put("tagName", "default".equals(firstTagName) ? firstOperation.baseName : firstTagName);
+            objs.put("tagDescription", firstTag.getDescription());
         }
 
         return objs;

modules/openapi-generator/src/main/resources/JavaSpring/api.mustache

@@ -79,10 +79,10 @@ import {{javaxPackage}}.annotation.Generated;
 @Controller
 {{/useSpringController}}
 {{#swagger2AnnotationLibrary}}
-@Tag(name = "{{{baseName}}}", description = {{#tagDescription}}"{{{.}}}"{{/tagDescription}}{{^tagDescription}}"the {{{baseName}}} API"{{/tagDescription}})
+@Tag(name = "{{{tagName}}}", description = {{#tagDescription}}"{{{.}}}"{{/tagDescription}}{{^tagDescription}}"the {{{tagName}}} API"{{/tagDescription}})
 {{/swagger2AnnotationLibrary}}
 {{#swagger1AnnotationLibrary}}
-@Api(value = "{{{baseName}}}", description = {{#tagDescription}}"{{{.}}}"{{/tagDescription}}{{^tagDescription}}"the {{{baseName}}} API"{{/tagDescription}})
+@Api(value = "{{{tagName}}}", description = {{#tagDescription}}"{{{.}}}"{{/tagDescription}}{{^tagDescription}}"the {{{tagName}}} API"{{/tagDescription}})
 {{/swagger1AnnotationLibrary}}
 {{#operations}}
 {{#virtualService}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

@@ -1896,6 +1896,18 @@ public void contractWithEnumContainsEnumConverter() throws IOException {
                 .assertMethod("typeConverter");
     }
 
+    @Test
+    public void shouldUseTheSameTagNameForTheInterfaceAndTheMethod_issue11570() throws IOException {
+        final Map<String, File> output = generateFromContract("src/test/resources/bugs/issue_11570.yml", SPRING_BOOT);
+
+        final String expectedTagName = "\"personTagWithExclamation!\"";
+        final String expectedTagDescription = "\"the personTagWithExclamation! API\"";
+
+        final String interfaceTag = "@Tag(name = " + expectedTagName + ", description = " + expectedTagDescription + ")";
+        final String methodTag = "tags = { " + expectedTagName + " }";
+        assertFileContains(output.get("PersonApi.java").toPath(), interfaceTag, methodTag);
+    }
+
     private Map<String, File> generateFromContract(String url, String library) throws IOException {
         return generateFromContract(url, library, new HashMap<>());
     }

modules/openapi-generator/src/test/resources/bugs/issue_11570.yml

@@ -0,0 +1,40 @@
+openapi: 3.0.0
+info:
+  description: Specification to reproduce issue 11570 where the wrong tags are applied to the controller
+  title: Required Api
+paths:
+  '/person':
+    post:
+      summary: Inserts a person
+      operationId: postPerson
+      tags:
+        - personTagWithExclamation!
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Person'
+
+      responses: ...
+
+components:
+  schemas:
+    Person:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          maxLength: 50
+          format: email
+        id:
+          type: integer
+    Alien:
+      type: object
+      properties:
+        name:
+          type: string
+        id:
+          type: integer

samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/PetApi.java

@@ -26,7 +26,7 @@
 
 @Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Validated
-@Api(value = "Pet", description = "Everything about your Pets")
+@Api(value = "pet", description = "Everything about your Pets")
 public interface PetApi {
 
     /**

samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/StoreApi.java

@@ -26,7 +26,7 @@
 
 @Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Validated
-@Api(value = "Store", description = "Access to Petstore orders")
+@Api(value = "store", description = "Access to Petstore orders")
 public interface StoreApi {
 
     /**

samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java

@@ -27,7 +27,7 @@
 
 @Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Validated
-@Api(value = "User", description = "Operations about user")
+@Api(value = "user", description = "Operations about user")
 public interface UserApi {
 
     /**

samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java

@@ -25,7 +25,7 @@
 
 @Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Validated
-@Api(value = "Pet", description = "Everything about your Pets")
+@Api(value = "pet", description = "Everything about your Pets")
 public interface PetApi {
 
     /**

samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/StoreApi.java

@@ -25,7 +25,7 @@
 
 @Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Validated
-@Api(value = "Store", description = "Access to Petstore orders")
+@Api(value = "store", description = "Access to Petstore orders")
 public interface StoreApi {
 
     /**

samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/UserApi.java

@@ -26,7 +26,7 @@
 
 @Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Validated
-@Api(value = "User", description = "Operations about user")
+@Api(value = "user", description = "Operations about user")
 public interface UserApi {
 
     /**