Support for nullable request parameters in Kotlin. Fixes #2006

bnasslahsen · bnasslahsen · commit e16183c87833 · 2022-12-20T15:02:19.000+01:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java
@@ -28,6 +28,7 @@
 
 /**
  * The type Constants.
+ *
  * @author bnasslahsen
  */
 public final class Constants {
@@ -393,6 +394,11 @@ public final class Constants {
 	 */
 	public static final String SPRINGDOC_SORT_CONVERTER_ENABLED = "springdoc.model-converters.sort-converter.enabled";
 
+	/**
+	 * The constant SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED.
+	 */
+	public static final String SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED = "springdoc.nullable-request-parameter-enabled";
+
 	/**
 	 * Instantiates a new Constants.
 	 */
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java
@@ -38,6 +38,7 @@
 
 /**
  * The type Spring doc config properties.
+ *
  * @author bnasslahsen
  */
 @Lazy(false)
@@ -196,6 +197,38 @@ public class SpringDocConfigProperties {
 	 */
 	private SortConverter sortConverter = new SortConverter();
 
+	/**
+	 * The Nullable request parameter enabled.
+	 */
+	private boolean nullableRequestParameterEnabled;
+
+	/**
+	 * Gets override with generic response.
+	 *
+	 * @return the override with generic response
+	 */
+	public Boolean getOverrideWithGenericResponse() {
+		return overrideWithGenericResponse;
+	}
+
+	/**
+	 * Is nullable request parameter enabled boolean.
+	 *
+	 * @return the boolean
+	 */
+	public boolean isNullableRequestParameterEnabled() {
+		return nullableRequestParameterEnabled;
+	}
+
+	/**
+	 * Sets nullable request parameter enabled.
+	 *
+	 * @param nullableRequestParameterEnabled the nullable request parameter enabled
+	 */
+	public void setNullableRequestParameterEnabled(boolean nullableRequestParameterEnabled) {
+		this.nullableRequestParameterEnabled = nullableRequestParameterEnabled;
+	}
+
 	/**
 	 * Is default support form data boolean.
 	 *
@@ -252,6 +285,7 @@ public void setShowSpringCloudFunctions(boolean showSpringCloudFunctions) {
 
 	/**
 	 * Is default flat param object
+	 *
 	 * @return the boolean
 	 */
 	public boolean isDefaultFlatParamObject() {
@@ -768,6 +802,7 @@ public void setPreLoadingEnabled(boolean preLoadingEnabled) {
 
 	/**
 	 * The type Model converters.
+	 *
 	 * @author bnasslashen
 	 */
 	public static class ModelConverters {
@@ -844,6 +879,7 @@ public void setPolymorphicConverter(PolymorphicConverter polymorphicConverter) {
 
 		/**
 		 * The type Sort converter.
+		 *
 		 * @author daniel -shuy
 		 */
 		public static class SortConverter {
@@ -874,6 +910,7 @@ public void setEnabled(boolean enabled) {
 
 		/**
 		 * The type Deprecating converter.
+		 *
 		 * @author bnasslashen
 		 */
 		public static class DeprecatingConverter {
@@ -934,6 +971,7 @@ public void setEnabled(boolean enabled) {
 
 		/**
 		 * The type Pageable converter.
+		 *
 		 * @author bnasslashen
 		 */
 		public static class PageableConverter {
@@ -965,6 +1003,7 @@ public void setEnabled(boolean enabled) {
 
 	/**
 	 * The type Webjars.
+	 *
 	 * @author bnasslahsen
 	 */
 	public static class Webjars {
@@ -994,6 +1033,7 @@ public void setPrefix(String prefix) {
 
 	/**
 	 * The type Api docs.
+	 *
 	 * @author bnasslahsen
 	 */
 	public static class ApiDocs {
@@ -1117,11 +1157,11 @@ public void setVersion(OpenApiVersion version) {
 		 */
 		public enum OpenApiVersion {
 			/**
-			 *Openapi 3.0.1 version.
+			 * Openapi 3.0.1 version.
 			 */
 			OPENAPI_3_0("3.0.1"),
 			/**
-			 *Openapi 3.1.0 version.
+			 * Openapi 3.1.0 version.
 			 */
 			OPENAPI_3_1("3.1.0");
 
@@ -1153,6 +1193,7 @@ public String getVersion() {
 
 	/**
 	 * The type Groups.
+	 *
 	 * @author bnasslahsen
 	 */
 	public static class Groups {
@@ -1183,6 +1224,7 @@ public void setEnabled(boolean enabled) {
 
 	/**
 	 * The type Cache.
+	 *
 	 * @author bnasslahsen
 	 */
 	public static class Cache {
@@ -1212,6 +1254,7 @@ public void setDisabled(boolean disabled) {
 
 	/**
 	 * The type Group config.
+	 *
 	 * @author bnasslahsen
 	 */
 	public static class GroupConfig {
diff --git a/springdoc-openapi-kotlin/src/main/java/org/springdoc/kotlin/SpringDocKotlinConfiguration.kt b/springdoc-openapi-kotlin/src/main/java/org/springdoc/kotlin/SpringDocKotlinConfiguration.kt
@@ -1,6 +1,7 @@
 package org.springdoc.kotlin
 
 import com.fasterxml.jackson.module.kotlin.KotlinModule
+import io.swagger.v3.oas.annotations.Parameter
 import io.swagger.v3.oas.models.media.ByteArraySchema
 import org.springdoc.core.Constants
 import org.springdoc.core.SpringDocConfiguration
@@ -14,6 +15,7 @@ import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
 import org.springframework.context.annotation.Lazy
 import org.springframework.core.MethodParameter
+import org.springframework.core.annotation.AnnotatedElementUtils
 import kotlin.coroutines.Continuation
 import kotlin.reflect.KParameter
 import kotlin.reflect.jvm.kotlinFunction
@@ -60,13 +62,25 @@ class SpringDocKotlinConfiguration(objectMapperProvider: ObjectMapperProvider) {
 	 */
 	@Bean
 	@Lazy(false)
+	@ConditionalOnProperty(
+		name = [Constants.SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED],
+		matchIfMissing = true
+	)
 	@ConditionalOnMissingBean
 	fun nullableKotlinRequestParameterCustomizer(): ParameterCustomizer {
 		return ParameterCustomizer { parameterModel, methodParameter ->
 			if (parameterModel == null) return@ParameterCustomizer null
 			val kParameter = methodParameter.toKParameter()
 			if (kParameter != null) {
-				parameterModel.required = kParameter.type.isMarkedNullable == false
+				val parameterDoc = AnnotatedElementUtils.findMergedAnnotation(
+					AnnotatedElementUtils.forAnnotations(*methodParameter.parameterAnnotations),
+					Parameter::class.java
+				)
+				// Swagger @Parameter annotation takes precedence
+				if (parameterDoc != null && parameterDoc.required)
+					parameterModel.required = parameterDoc.required
+				else
+					parameterModel.required = kParameter.type.isMarkedNullable == false
 			}
 			return@ParameterCustomizer parameterModel
 		}
diff --git a/springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app7/ExampleController.kt b/springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app7/ExampleController.kt
@@ -1,6 +1,9 @@
 package test.org.springdoc.api.app7
 
+import io.swagger.v3.oas.annotations.Parameter
+import io.swagger.v3.oas.annotations.parameters.RequestBody
 import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PostMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
@@ -11,4 +14,8 @@ data class Greeting(val greeting: String)
 interface ExampleController {
     @GetMapping("/")
     fun greet(@RequestParam name: String?): Greeting
+
+	@GetMapping("/test")
+	fun test(@RequestParam @Parameter(required = true) name: String?): Greeting
+
 }
diff --git a/springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app8/ExampleController.kt b/springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app8/ExampleController.kt
@@ -0,0 +1,17 @@
+package test.org.springdoc.api.app8
+
+import io.swagger.v3.oas.annotations.Parameter
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestParam
+import org.springframework.web.bind.annotation.RestController
+
+data class Greeting(val greeting: String)
+
+@RestController
+interface ExampleController {
+    @GetMapping("/")
+    fun greet(@RequestParam name: String?): Greeting
+
+	@GetMapping("/test")
+	fun test(@RequestParam @Parameter(required = true) name: String?): Greeting
+}
diff --git a/springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app8/SpringDocApp8Test.kt b/springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app8/SpringDocApp8Test.kt
@@ -0,0 +1,49 @@
+/*
+ *
+ *  * 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.app8
+
+import org.springdoc.core.Constants
+import org.springframework.aop.framework.ProxyFactory
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.ComponentScan
+import org.springframework.context.support.GenericApplicationContext
+import org.springframework.test.context.TestPropertySource
+import test.org.springdoc.api.AbstractKotlinSpringDocTest
+
+@TestPropertySource(properties =  [Constants.SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED+"=false"])
+class SpringDocApp8Test : AbstractKotlinSpringDocTest() {
+
+	@SpringBootApplication
+	@ComponentScan(basePackages = ["org.springdoc", "test.org.springdoc.api.app8"])
+	class DemoApplication{
+		@Bean
+		fun controller(applicationContext: GenericApplicationContext): ExampleController {
+			return createProxy(ExampleController::class.java)
+		}
+
+		private fun <T> createProxy(clazz: Class<T>): T {
+			val proxyFactory = ProxyFactory(clazz)
+			proxyFactory.targetClass = clazz
+			@Suppress("UNCHECKED_CAST")
+			return proxyFactory.proxy as T
+		}
+	}
+
+}
diff --git a/springdoc-openapi-kotlin/src/test/resources/results/app7.json b/springdoc-openapi-kotlin/src/test/resources/results/app7.json
@@ -40,6 +40,36 @@
           }
         }
       }
+    },
+    "/test": {
+      "get": {
+        "tags": [
+          "example-controller"
+        ],
+        "operationId": "test",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Greeting"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
diff --git a/springdoc-openapi-kotlin/src/test/resources/results/app8.json b/springdoc-openapi-kotlin/src/test/resources/results/app8.json
