Support for kotlin. Deprecated. Fixes #414

Author: bnasslahsen

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

@@ -85,11 +85,16 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 
 	private static final List<Class<?>> ADDITIONAL_REST_CONTROLLERS = new ArrayList<>();
 	private static final List<Class<?>> HIDDEN_REST_CONTROLLERS = new ArrayList<>();
+	private static final List<Class> DEPRECATED_TYPES = new ArrayList<>();
 
 	private boolean computeDone;
 
 	private final String groupName;
 
+	static {
+		DEPRECATED_TYPES.add(Deprecated.class);
+	}
+
 	protected AbstractOpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties) {
@@ -177,7 +182,7 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 
 			Operation operation = (existingOperation != null) ? existingOperation : new Operation();
 
-			if (ReflectionUtils.getAnnotation(method, Deprecated.class) != null) {
+			if (isDeprecatedType(method)) {
 				operation.setDeprecated(true);
 			}
 
@@ -394,4 +399,12 @@ 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));
 	}
+
+	public static void addDeprecatedType(Class<?> cls){
+		DEPRECATED_TYPES.add(cls);
+	}
+
+	private boolean isDeprecatedType(Method method) {
+		return DEPRECATED_TYPES.stream().anyMatch(clazz -> (ReflectionUtils.getAnnotation(method, clazz) != null));
+	}
 }

Diff for: springdoc-openapi-kotlin/src/main/java/org/springdoc/core/KotlinCoroutinesRequestBuilder.java

@@ -18,29 +18,25 @@
 
 package org.springdoc.core;
 
-import java.util.List;
-import java.util.Optional;
-
-import org.springdoc.core.customizers.OperationCustomizer;
-import org.springdoc.core.customizers.ParameterCustomizer;
+import kotlin.Deprecated;
+import kotlin.coroutines.Continuation;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
 
+import static org.springdoc.api.AbstractOpenApiResource.addDeprecatedType;
+import static org.springdoc.core.AbstractRequestBuilder.addRequestWrapperToIgnore;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 
 @Configuration
 @ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
 public class SpringDocKotlinConfiguration {
 
-	@Bean
-	@Primary
-	KotlinCoroutinesRequestBuilder kotlinCoroutinesRequestBuilder(GenericParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
-			OperationBuilder operationBuilder, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<ParameterCustomizer>> parameterCustomizers) {
-		return new KotlinCoroutinesRequestBuilder(parameterBuilder, requestBodyBuilder,
-				operationBuilder, operationCustomizers, parameterCustomizers);
+	static {
+		addRequestWrapperToIgnore(Continuation.class);
+		addDeprecatedType(Deprecated.class);
 	}
 
 	@Bean

Diff for: springdoc-openapi-kotlin/src/main/java/org/springdoc/core/SpringDocKotlinConfiguration.java

@@ -45,6 +45,7 @@ abstract class AbstractKotlinSpringDocTest {
 				.expectStatus().isOk.expectBody().returnResult()
 
 		val result = String(getResult.responseBody!!)
+		print(result)
 		val className = javaClass.simpleName
 		val testNumber = className.replace("[^0-9]".toRegex(), "")
 

Diff for: springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/AbstractKotlinSpringDocTest.kt

@@ -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.app3
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.context.annotation.ComponentScan
+import test.org.springdoc.api.AbstractKotlinSpringDocTest
+
+@ComponentScan(basePackages = ["org.springdoc", "test.org.springdoc.api.app3"])
+class SpringDocApp3Test : AbstractKotlinSpringDocTest() {
+
+	@SpringBootApplication
+	open class DemoApplication
+
+}

Diff for: springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app3/SpringDocApp3Test.kt

@@ -0,0 +1,45 @@
+/*
+ *
+ *  * 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.app3
+
+import kotlinx.coroutines.reactor.mono
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+enum class SystemStatus(val status: String) {
+	OK("OK")
+}
+
+data class SystemStatusResponse(
+		val status: SystemStatus
+)
+
+@RestController
+@RequestMapping("/status")
+class SystemStatusController {
+	@GetMapping
+	suspend fun index() = SystemStatusResponse(SystemStatus.OK)
+
+	@GetMapping("/foo")
+	@Deprecated("")
+	fun foo() = mono {
+		SystemStatusResponse(SystemStatus.OK)
+	}
+}

Diff for: springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app3/SystemStatusController.kt

@@ -0,0 +1,71 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/status": {
+      "get": {
+        "tags": [
+          "system-status-controller"
+        ],
+        "operationId": "index",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/SystemStatusResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/status/foo": {
+      "get": {
+        "tags": [
+          "system-status-controller"
+        ],
+        "operationId": "foo",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/SystemStatusResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": true
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SystemStatusResponse": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "OK"
+            ]
+          }
+        }
+      }
+    }
+  }
+}