Support REST Controllers with default empty @RequestMapping. Fixes #378

Author: bnasslahsen

pom.xml

@@ -71,7 +71,7 @@
 		<swagger-api.version>2.1.1</swagger-api.version>
 		<swagger-ui.version>3.24.3</swagger-ui.version>
 		<webjars-locator.version>0.38</webjars-locator.version>
-		<spring-security-oauth2.version>2.3.5.RELEASE</spring-security-oauth2.version>
+		<spring-security-oauth2.version>2.3.8.RELEASE</spring-security-oauth2.version>
 	</properties>
 
 	<dependencyManagement>

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -24,7 +24,9 @@
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.time.Instant;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -80,6 +82,8 @@ public abstract class AbstractOpenApiResource {
 
 	private final SpringDocConfigProperties springDocConfigProperties;
 
+	private static final List<Class<?>> ADDITIONAL_REST_CONTROLLERS = new ArrayList<>();
+
 	private boolean computeDone;
 
 	private final String groupName;
@@ -104,7 +108,8 @@ protected synchronized OpenAPI getOpenApi() {
 			openAPIBuilder.build();
 			Map<String, Object> restControllersMap = openAPIBuilder.getRestControllersMap();
 			Map<String, Object> requestMappingMap = openAPIBuilder.getRequestMappingMap();
-			Map<String, Object> restControllers = Stream.of(restControllersMap, requestMappingMap)
+			Map<String, Object> controllerMap = openAPIBuilder.getControllersMap();
+			Map<String, Object> restControllers = Stream.of(restControllersMap, requestMappingMap, controllerMap)
 					.flatMap(mapEl -> mapEl.entrySet().stream())
 					.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
 							Hidden.class) == null))
@@ -344,4 +349,17 @@ protected String decode(String requestURI) {
 			return requestURI;
 		}
 	}
+
+	protected boolean isAdditionalRestController(Class<?> rawClass) {
+		return ADDITIONAL_REST_CONTROLLERS.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
+	}
+
+	public static void addRestControllers(Class<?>... classes){
+		ADDITIONAL_REST_CONTROLLERS.addAll(Arrays.asList(classes));
+	}
+
+	protected Set getDefaultAllowedHttpMethods(){
+		RequestMethod[] allowedRequestMethods = {RequestMethod.GET,  RequestMethod.POST, RequestMethod.PUT, RequestMethod.PATCH, RequestMethod.DELETE, RequestMethod.OPTIONS, RequestMethod.HEAD} ;
+		return new HashSet<>(Arrays.asList(allowedRequestMethods));
+	}
 }

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

@@ -56,6 +56,7 @@
 import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.core.type.filter.AnnotationTypeFilter;
+import org.springframework.stereotype.Controller;
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -388,6 +389,10 @@ public Map<String, Object> getRequestMappingMap() {
 		return context.getBeansWithAnnotation(RequestMapping.class);
 	}
 
+	public Map<String, Object> getControllersMap() {
+		return context.getBeansWithAnnotation(Controller.class);
+	}
+
 	public Map<String, Object> getControllerAdviceMap() {
 		Map<String, Object> controllerAdviceMap = context.getBeansWithAnnotation(ControllerAdvice.class);
 		return Stream.of(controllerAdviceMap).flatMap(mapEl -> mapEl.entrySet().stream()).filter(

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

@@ -30,7 +30,6 @@
 import java.util.stream.Collectors;
 
 import io.swagger.v3.core.util.AnnotationsUtils;
-import io.swagger.v3.core.util.ReflectionUtils;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
@@ -45,6 +44,7 @@
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.apache.commons.lang3.StringUtils;
 
+import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.CollectionUtils;
 
 import static org.springdoc.core.Constants.DEFAULT_DESCRIPTION;
@@ -128,10 +128,10 @@ public OpenAPI parse(Components components, io.swagger.v3.oas.annotations.Operat
 	}
 
 	public boolean isHidden(Method method) {
-		io.swagger.v3.oas.annotations.Operation apiOperation = ReflectionUtils.getAnnotation(method,
+		io.swagger.v3.oas.annotations.Operation apiOperation = AnnotationUtils.findAnnotation(method,
 				io.swagger.v3.oas.annotations.Operation.class);
 		return (apiOperation != null && (apiOperation.hidden()))
-				|| (ReflectionUtils.getAnnotation(method, Hidden.class) != null);
+				|| (AnnotationUtils.findAnnotation(method, Hidden.class) != null);
 	}
 
 	public Optional<Map<String, Callback>> buildCallbacks(

springdoc-openapi-security/src/test/resources/results/app4.json

@@ -107,6 +107,39 @@
           }
         }
       }
+    },
+    "/oauth/check_token": {
+      "post": {
+        "tags": [
+          "check-token-endpoint"
+        ],
+        "operationId": "checkToken",
+        "parameters": [
+          {
+            "name": "token",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "object"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -129,11 +162,9 @@
             "type": "string",
             "format": "date-time"
           },
-          "tokenType": {
-            "type": "string"
-          },
-          "expired": {
-            "type": "boolean"
+          "expiresIn": {
+            "type": "integer",
+            "format": "int32"
           },
           "scope": {
             "uniqueItems": true,
@@ -148,12 +179,14 @@
               "type": "object"
             }
           },
+          "expired": {
+            "type": "boolean"
+          },
+          "tokenType": {
+            "type": "string"
+          },
           "refreshToken": {
             "$ref": "#/components/schemas/OAuth2RefreshToken"
-          },
-          "expiresIn": {
-            "type": "integer",
-            "format": "int32"
           }
         }
       },

springdoc-openapi-webflux-core/src/main/java/org/springdoc/api/OpenApiResource.java

@@ -102,6 +102,9 @@ protected void getPaths(Map<String, Object> restControllers) {
 				if (operationPath.startsWith(DEFAULT_PATH_SEPARATOR)
 						&& restControllers.containsKey(handlerMethod.getBean().toString()) && isPackageToScan(handlerMethod.getBeanType().getPackage().getName()) && isPathToMatch(operationPath)) {
 					Set<RequestMethod> requestMethods = requestMappingInfo.getMethodsCondition().getMethods();
+					// default allowed requestmethods
+					if (requestMethods.isEmpty())
+						requestMethods = this.getDefaultAllowedHttpMethods();
 					calculatePath(openAPIBuilder, handlerMethod, operationPath, requestMethods);
 				}
 			}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java

@@ -45,7 +45,7 @@ public abstract class AbstractSpringDocTest {
 	protected String groupName = "";
 
 	@Autowired
-	private WebTestClient webTestClient;
+	protected WebTestClient webTestClient;
 
 	public static String getContent(String fileName) throws Exception {
 		try {

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app67/HelloController.java

@@ -0,0 +1,33 @@
+/*
+ *
+ *  * 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.app67;
+
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api")
+public class HelloController {
+
+	@RequestMapping
+	public String test() {
+		return "ok";
+	}
+
+}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app67/SpringDocApp67Test.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  * 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.app67;
+
+import org.junit.jupiter.api.Test;
+import org.springdoc.core.Constants;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+
+public class SpringDocApp67Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	@ComponentScan(basePackages = { "org.springdoc", "test.org.springdoc.api.app67" })
+	static class SpringDocTestApp {}
+
+	@Test
+	public void testApp() throws Exception {
+		webTestClient.get().uri(Constants.DEFAULT_API_DOCS_URL + groupName).exchange().expectStatus().isOk().expectBody()
+				.jsonPath("$.openapi").isEqualTo("3.0.1")
+				.jsonPath("$.paths./api.get.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.get.responses.200.content.['*/*'].schema.type").isEqualTo("string")
+				.jsonPath("$.paths./api.post.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.post.responses.200.content.['*/*'].schema.type").isEqualTo("string")
+				.jsonPath("$.paths./api.put.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.put.responses.200.content.['*/*'].schema.type").isEqualTo("string")
+				.jsonPath("$.paths./api.patch.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.patch.responses.200.content.['*/*'].schema.type").isEqualTo("string")
+				.jsonPath("$.paths./api.delete.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.delete.responses.200.content.['*/*'].schema.type").isEqualTo("string")
+				.jsonPath("$.paths./api.options.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.options.responses.200.content.['*/*'].schema.type").isEqualTo("string")
+				.jsonPath("$.paths./api.head.tags[0]").isEqualTo("hello-controller")
+				.jsonPath("$.paths./api.head.responses.200.content.['*/*'].schema.type").isEqualTo("string");
+	}
+}