PR#355 merge

Author: bnasslahsen

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

@@ -39,9 +39,12 @@ public abstract class AbstractResponseBuilder {
 
     private final OperationBuilder operationBuilder;
 
-    protected AbstractResponseBuilder(OperationBuilder operationBuilder) {
+    private final List<ReturnTypeParser> returnTypeParsers;
+
+    protected AbstractResponseBuilder(OperationBuilder operationBuilder, List<ReturnTypeParser> returnTypeParsers) {
         super();
         this.operationBuilder = operationBuilder;
+        this.returnTypeParsers = returnTypeParsers;
     }
 
     public ApiResponses build(Components components, HandlerMethod handlerMethod, Operation operation,
@@ -203,7 +206,7 @@ private Set<io.swagger.v3.oas.annotations.responses.ApiResponse> getApiResponses
 
     private Content buildContent(Components components, Method method, String[] methodProduces, JsonView jsonView) {
         Content content = new Content();
-        Type returnType = method.getGenericReturnType();
+        Type returnType = getReturnType(method);
         if (isVoid(returnType)) {
             // if void, no content
             content = null;
@@ -219,6 +222,19 @@ private Content buildContent(Components components, Method method, String[] meth
         return content;
     }
 
+    private Type getReturnType(Method method) {
+        Type returnType = Object.class;
+        for (ReturnTypeParser returnTypeParser: returnTypeParsers) {
+            if (returnType.getTypeName().equals(Object.class.getTypeName())) {
+                returnType = returnTypeParser.getReturnType(method);
+            } else {
+                break;
+            }
+        }
+
+        return returnType;
+    }
+
     private Schema<?> calculateSchema(Components components, Type returnType, JsonView jsonView) {
         Schema<?> schemaN = null;
         if (isVoid(returnType)) {

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

@@ -27,20 +27,11 @@
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.method.HandlerMethod;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
+import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import static org.springdoc.core.Constants.DEFAULT_SERVER_DESCRIPTION;
-import static org.springdoc.core.Constants.DEFAULT_TITLE;
-import static org.springdoc.core.Constants.DEFAULT_VERSION;
+import static org.springdoc.core.Constants.*;
 
 public class OpenAPIBuilder {
 

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

@@ -0,0 +1,12 @@
+package org.springdoc.core;
+
+import java.lang.reflect.Method;
+import java.lang.reflect.Type;
+
+interface ReturnTypeParser {
+    default Type getReturnType(Method method) {
+        return method.getGenericReturnType();
+    }
+}
+
+class GenericReturnTypeParser implements ReturnTypeParser{}

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

@@ -79,6 +79,11 @@ public SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils
         return new SecurityParser(propertyResolverUtils);
     }
 
+    @Bean
+    public GenericReturnTypeParser genericReturnTypeParser() {
+        return new GenericReturnTypeParser();
+    }
+
     static class ConditionOnCacheOrGroupedOpenApi extends AnyNestedCondition {
 
         ConditionOnCacheOrGroupedOpenApi() {

springdoc-openapi-kotlin/pom.xml

@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <artifactId>springdoc-openapi-kotlin</artifactId>
     <name>${project.artifactId}</name>
@@ -20,11 +21,53 @@
             <version>${kotlin.version}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.jetbrains.kotlinx</groupId>
+            <artifactId>kotlinx-coroutines-reactor</artifactId>
+            <version>${kotlin-coroutines.version}</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-webflux-core</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>kotlin-maven-plugin</artifactId>
+                <groupId>org.jetbrains.kotlin</groupId>
+                <version>${kotlin.version}</version>
+                <executions>
+                    <execution>
+                        <id>compile</id>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                        <configuration>
+                            <sourceDirs>
+                                <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
+                                <sourceDir>${project.basedir}/src/main/java</sourceDir>
+                            </sourceDirs>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>test-compile</id>
+                        <goals>
+                            <goal>test-compile</goal>
+                        </goals>
+                        <configuration>
+                            <sourceDirs>
+                                <sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
+                                <sourceDir>${project.basedir}/src/test/java</sourceDir>
+                            </sourceDirs>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>

springdoc-openapi-kotlin/src/main/java/org/springdoc/core/KotlinCoroutinesReturnTypeParser.java

@@ -0,0 +1,28 @@
+package org.springdoc.core;
+
+import kotlin.coroutines.Continuation;
+
+import java.lang.reflect.*;
+import java.util.Arrays;
+import java.util.Optional;
+
+public class KotlinCoroutinesReturnTypeParser implements ReturnTypeParser {
+
+    @Override
+    public Type getReturnType(Method method) {
+        Type returnType = Object.class;
+        Optional<Parameter> continuationParameter = Arrays.stream(method.getParameters())
+                .filter((parameter) -> parameter.getType().getCanonicalName().equals(Continuation.class.getCanonicalName()))
+                .findFirst();
+        if (continuationParameter.isPresent()) {
+            Type continuationType = continuationParameter.get().getParameterizedType();
+            if (continuationType instanceof ParameterizedType) {
+                Type actualTypeArguments = ((ParameterizedType) continuationType).getActualTypeArguments()[0];
+                if (actualTypeArguments instanceof WildcardType) {
+                    returnType = ((WildcardType) actualTypeArguments).getLowerBounds()[0];
+                }
+            }
+        }
+        return returnType;
+    }
+}

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

@@ -24,5 +24,10 @@ KotlinCoroutinesRequestBuilder kotlinCoroutinesRequestBuilder(AbstractParameterB
                 operationBuilder, operationCustomizers, parameterCustomizers);
     }
 
+    @Bean
+    KotlinCoroutinesReturnTypeParser kotlinCoroutinesReturnTypeParser() {
+        return new KotlinCoroutinesReturnTypeParser();
+    }
+
 
 }

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

@@ -0,0 +1,44 @@
+package test.org.springdoc.api
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import org.junit.Assert.assertEquals
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.springdoc.core.Constants
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest
+import org.springframework.test.context.ActiveProfiles
+import org.springframework.test.context.junit4.SpringRunner
+import org.springframework.test.web.reactive.server.WebTestClient
+import java.nio.file.Files
+import java.nio.file.Paths
+
+@RunWith(SpringRunner::class)
+@WebFluxTest
+@ActiveProfiles("test")
+abstract class AbstractKotlinSpringDocTest {
+
+    @Autowired
+    private val webTestClient: WebTestClient? = null
+
+    @Autowired
+    private val objectMapper: ObjectMapper? = null
+
+    @Test
+    @Throws(Exception::class)
+    fun testApp() {
+        val getResult = webTestClient!!.get().uri(Constants.DEFAULT_API_DOCS_URL).exchange()
+                .expectStatus().isOk.expectBody().returnResult()
+
+        val result = String(getResult.responseBody!!)
+        val className = javaClass.simpleName
+        val testNumber = className.replace("[^0-9]".toRegex(), "")
+
+        val path = Paths.get(javaClass.classLoader.getResource("results/app$testNumber.json")!!.toURI())
+        val fileBytes = Files.readAllBytes(path)
+        val expected = String(fileBytes)
+
+        assertEquals(objectMapper!!.readTree(expected), objectMapper.readTree(result))
+    }
+
+}

springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app2/SpringDocApp2Test.kt

@@ -0,0 +1,13 @@
+package test.org.springdoc.api.app2
+
+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.app2"])
+class SpringDocApp2Test : AbstractKotlinSpringDocTest() {
+
+    @SpringBootApplication
+    open class DemoApplication
+
+}

springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app2/SystemStatusController.kt

@@ -0,0 +1,26 @@
+package test.org.springdoc.api.app2
+
+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")
+    fun foo() = mono {
+        SystemStatusResponse(SystemStatus.OK)
+    }
+}