Add tests for @ParameterObject on spring boot webflux. Fixes #1325

Author: bnasslahsen

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

@@ -0,0 +1,19 @@
+package test.org.springdoc.api.app102;
+
+import javax.validation.constraints.NotBlank;
+
+import io.swagger.v3.oas.annotations.Parameter;
+
+public class InheritedRequestParams extends RequestParams {
+	@Parameter(description = "parameter from child of RequestParams")
+	@NotBlank
+	private String childParam;
+
+	public String getChildParam() {
+		return childParam;
+	}
+
+	public void setChildParam(String childParam) {
+		this.childParam = childParam;
+	}
+}

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

@@ -0,0 +1,122 @@
+package test.org.springdoc.api.app102;
+
+import java.math.BigInteger;
+import java.util.List;
+import java.util.Optional;
+
+import io.swagger.v3.oas.annotations.Parameter;
+
+import org.springframework.lang.Nullable;
+
+public class RequestParams {
+
+	@Parameter(description = "string parameter")
+	private String stringParam;
+
+	@Deprecated
+	private String stringParam1;
+
+	@Parameter(description = "string parameter2", required = true)
+	private String stringParam2;
+
+	@Parameter(description = "int parameter")
+	private int intParam;
+
+	private Optional<String> intParam2;
+
+	@Nullable
+	private String intParam3;
+
+	private Nested nested;
+
+	private List<Nested> nestedList;
+
+	public String getStringParam() {
+		return stringParam;
+	}
+
+	public void setStringParam(String stringParam) {
+		this.stringParam = stringParam;
+	}
+
+	public int getIntParam() {
+		return intParam;
+	}
+
+	public void setIntParam(int intParam) {
+		this.intParam = intParam;
+	}
+
+	public Optional<String> getIntParam2() {
+		return intParam2;
+	}
+
+	public void setIntParam2(Optional<String> intParam2) {
+		this.intParam2 = intParam2;
+	}
+
+	@Nullable
+	public String getIntParam3() {
+		return intParam3;
+	}
+
+	public void setIntParam3(@Nullable String intParam3) {
+		this.intParam3 = intParam3;
+	}
+
+	public String getStringParam1() {
+		return stringParam1;
+	}
+
+	public void setStringParam1(String stringParam1) {
+		this.stringParam1 = stringParam1;
+	}
+
+	public String getStringParam2() {
+		return stringParam2;
+	}
+
+	public void setStringParam2(String stringParam2) {
+		this.stringParam2 = stringParam2;
+	}
+
+	public Nested getNested() {
+		return nested;
+	}
+
+	public void setNested(Nested nested) {
+		this.nested = nested;
+	}
+
+	public List<Nested> getNestedList() {
+		return nestedList;
+	}
+
+	public void setNestedList(List<Nested> nestedList) {
+		this.nestedList = nestedList;
+	}
+
+	public static class Nested {
+		private String param1;
+
+		private BigInteger param2;
+
+		@Parameter(description = "nested string parameter")
+		public String getParam1() {
+			return param1;
+		}
+
+		public void setParam1(String param1) {
+			this.param1 = param1;
+		}
+
+		@Parameter(description = "nested BigInteger parameter")
+		public BigInteger getParam2() {
+			return param2;
+		}
+
+		public void setParam2(BigInteger param2) {
+			this.param2 = param2;
+		}
+	}
+}

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

@@ -0,0 +1,14 @@
+package test.org.springdoc.api.app102;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+
+public class SpringDocApp102Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	@ComponentScan(basePackages = { "org.springdoc", "test.org.springdoc.api.app102" })
+	static class SpringDocTestApp {}
+
+}

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

@@ -0,0 +1,15 @@
+package test.org.springdoc.api.app102;
+
+import org.springdoc.api.annotations.ParameterObject;
+
+import org.springframework.lang.Nullable;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class TestController {
+	@GetMapping("test")
+	public void getTest(@RequestParam @Nullable String param, @ParameterObject InheritedRequestParams requestParams) {
+	}
+}

springdoc-openapi-webflux-core/src/test/resources/results/app102.json

@@ -0,0 +1,142 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "get": {
+        "tags": [
+          "test-controller"
+        ],
+        "operationId": "getTest",
+        "parameters": [
+          {
+            "name": "param",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "childParam",
+            "in": "query",
+            "description": "parameter from child of RequestParams",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "stringParam",
+            "in": "query",
+            "description": "string parameter",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "stringParam1",
+            "in": "query",
+            "required": false,
+            "deprecated": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "stringParam2",
+            "in": "query",
+            "description": "string parameter2",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "intParam",
+            "in": "query",
+            "description": "int parameter",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          {
+            "name": "intParam2",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "intParam3",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "nested.param1",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "nested.param2",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "nestedList",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Nested"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Nested": {
+        "type": "object",
+        "properties": {
+          "param1": {
+            "type": "string"
+          },
+          "param2": {
+            "type": "integer"
+          }
+        }
+      }
+    }
+  }
+}