Added support to disable autotagging of @RestController Classes. Fixes #420.

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java

@@ -89,8 +89,10 @@ public class OpenAPIBuilder {
 
 	private String serverBaseUrl;
 
+	private final SpringDocConfigProperties springDocConfigProperties;
+
 	@SuppressWarnings("WeakerAccess")
-	OpenAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider) {
+	OpenAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider, SpringDocConfigProperties springDocConfigProperties) {
 		if (openAPI.isPresent()) {
 			this.openAPI = openAPI.get();
 			if (this.openAPI.getComponents() == null)
@@ -103,6 +105,7 @@ public class OpenAPIBuilder {
 		this.context = context;
 		this.securityParser = securityParser;
 		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
+		this.springDocConfigProperties=springDocConfigProperties;
 	}
 
 	private static String splitCamelCase(String str) {
@@ -210,7 +213,7 @@ public Operation buildTags(HandlerMethod handlerMethod, Operation operation, Ope
 			operation.setTags(new ArrayList<>(tagsStr));
 		}
 
-		if (CollectionUtils.isEmpty(operation.getTags())) {
+		if (CollectionUtils.isEmpty(operation.getTags()) && springDocConfigProperties.getAutoTagClasses()) {
 			operation.addTagsItem(splitCamelCase(handlerMethod.getBeanType().getSimpleName()));
 		}
 

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -50,6 +50,16 @@ public class SpringDocConfigProperties {
 
 	private List<GroupConfig> groupConfigs = new ArrayList<>();
 
+	private Boolean autoTagClasses = true;
+
+	public Boolean getAutoTagClasses() {
+		return autoTagClasses;
+	}
+
+	public void setAutoTagClasses(Boolean autoTagClasses) {
+		this.autoTagClasses = autoTagClasses;
+	}
+
 	public List<String> getPackagesToExclude() {
 		return packagesToExclude;
 	}
@@ -201,7 +211,8 @@ public void addGroupConfig(GroupConfig groupConfigs) {
 	}
 
 	public static class GroupConfig {
-		public GroupConfig() { }
+		public GroupConfig() {
+		}
 
 		public GroupConfig(String group, List<String> pathsToMatch, List<String> packagesToScan, List<String> packagesToExclude, List<String> pathsToExclude) {
 			this.pathsToMatch = pathsToMatch;

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

@@ -75,8 +75,8 @@ IgnoredParameterAnnotationsDefault ignoredParameterAnnotationsDefault() {
 	}
 
 	@Bean
-	public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider) {
-		return new OpenAPIBuilder(openAPI, context, securityParser, springSecurityOAuth2Provider);
+	public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,SpringDocConfigProperties springDocConfigProperties) {
+		return new OpenAPIBuilder(openAPI, context, securityParser, springSecurityOAuth2Provider,springDocConfigProperties);
 	}
 
 	@Bean

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app88/HelloController.java

@@ -0,0 +1,32 @@
+/*
+ *
+ *  * Copyright 2019-2020 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app88;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public String persons() {
+		return null;
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app88/SpringDocApp88Test.java

@@ -0,0 +1,31 @@
+/*
+ *
+ *  * Copyright 2019-2020 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app88;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+@TestPropertySource(properties = "springdoc.auto-tag-classes=false")
+public class SpringDocApp88Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app88.json

@@ -0,0 +1,33 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/persons": {
+      "get": {
+        "operationId": "persons",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}