Improve Management of multiple params in requestBody

Author: bnasslahsen

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

@@ -214,9 +214,13 @@ Schema calculateSchema(Components components, java.lang.reflect.Parameter parame
 		else {
 			schemaN = SpringDocAnnotationsUtils.resolveSchemaFromType(schemaImplementation, components, jsonView);
 		}
-		if (isRequestBodySchema(requestBodyInfo)) {
-			requestBodyInfo.getMergedSchema().addProperties(paramName, schemaN);
-			schemaN = requestBodyInfo.getMergedSchema();
+		if (requestBodyInfo != null) {
+			if (requestBodyInfo.getMergedSchema() != null) {
+				requestBodyInfo.getMergedSchema().addProperties(paramName, schemaN);
+				schemaN = requestBodyInfo.getMergedSchema();
+			}
+			else
+				requestBodyInfo.addProperties(paramName, schemaN);
 		}
 
 		return schemaN;
@@ -238,32 +242,30 @@ private Schema extractFileSchema(String paramName, RequestBodyInfo requestBodyIn
 
 	private Schema getFileSchema(RequestBodyInfo requestBodyInfo) {
 		Schema schemaN;
-		if (isRequestBodySchema(requestBodyInfo))
+		if (requestBodyInfo.getMergedSchema() != null)
 			schemaN = requestBodyInfo.getMergedSchema();
-		else
+		else {
 			schemaN = new ObjectSchema();
+			requestBodyInfo.setMergedSchema(schemaN);
+		}
 		return schemaN;
 	}
 
-	private boolean isRequestBodySchema(RequestBodyInfo requestBodyInfo) {
-		return requestBodyInfo != null && requestBodyInfo.getMergedSchema() != null;
-	}
-
 	protected abstract boolean isFile(ParameterizedType parameterizedType);
 
 	protected abstract boolean isFile(JavaType ct);
 
 	public boolean isFile(java.lang.reflect.Parameter parameter) {
-		boolean result =false;
-		Type type =  parameter.getParameterizedType();
+		boolean result = false;
+		Type type = parameter.getParameterizedType();
 		JavaType javaType = constructType(parameter.getType());
 		if (isFile(javaType)) {
-			result =true;
+			result = true;
 		}
 		else if (type instanceof ParameterizedType) {
 			ParameterizedType parameterizedType = (ParameterizedType) type;
 			if (isFile(parameterizedType)) {
-				result =true;
+				result = true;
 			}
 		}
 		return result;

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

@@ -145,7 +145,7 @@ public Operation build(Components components, HandlerMethod handlerMethod, Reque
 		if (pNames == null) {
 			pNames = reflectionParametersNames;
 		}
-		RequestBodyInfo requestBodyInfo = new RequestBodyInfo(methodAttributes);
+		RequestBodyInfo requestBodyInfo = new RequestBodyInfo();
 		List<Parameter> operationParameters = (operation.getParameters() != null) ? operation.getParameters()
 				: new ArrayList<>();
 		Map<String, io.swagger.v3.oas.annotations.Parameter> parametersDocMap = getApiParameters(handlerMethod.getMethod());
@@ -178,7 +178,6 @@ public Operation build(Components components, HandlerMethod handlerMethod, Reque
 					applyBeanValidatorAnnotations(parameter, Arrays.asList(parameters[i].getAnnotations()));
 				}
 				else if (!RequestMethod.GET.equals(requestMethod)) {
-					requestBodyInfo.incrementNbParam();
 					requestBodyInfo.setRequestBody(operation.getRequestBody());
 					requestBodyBuilder.calculateRequestBodyInfo(components, handlerMethod, methodAttributes, i,
 							parameterInfo, requestBodyInfo);

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

@@ -18,30 +18,17 @@
 
 package org.springdoc.core;
 
-import java.util.Arrays;
-
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.parameters.RequestBody;
 
-import org.springframework.http.MediaType;
-
 @SuppressWarnings("rawtypes")
 class RequestBodyInfo {
 
 	private RequestBody requestBody;
 
 	private Schema mergedSchema;
 
-	private int nbParams;
-
-	public RequestBodyInfo(MethodAttributes methodAttributes) {
-		String[] allConsumes = methodAttributes.getAllConsumes();
-		if (Arrays.asList(allConsumes).contains(MediaType.MULTIPART_FORM_DATA_VALUE)) {
-			this.initMergedSchema();
-		}
-	}
-
 	public RequestBody getRequestBody() {
 		return requestBody;
 	}
@@ -50,33 +37,18 @@ public void setRequestBody(RequestBody requestBody) {
 		this.requestBody = requestBody;
 	}
 
-	public void incrementNbParam() {
-		nbParams++;
-	}
-
 	public Schema getMergedSchema() {
-		if (mergedSchema == null && nbParams > 1) {
-			mergedSchema = new ObjectSchema();
-		}
 		return mergedSchema;
 	}
 
 	public void setMergedSchema(Schema mergedSchema) {
 		this.mergedSchema = mergedSchema;
 	}
 
-	private void initMergedSchema() {
-		if (mergedSchema == null) {
+	public void addProperties(String paramName, Schema schemaN) {
+		if (mergedSchema == null)
 			mergedSchema = new ObjectSchema();
-		}
-	}
-
-	public int getNbParams() {
-		return nbParams;
-	}
-
-	public void setNbParams(int nbParams) {
-		this.nbParams = nbParams;
+		mergedSchema.addProperties(paramName, schemaN);
 	}
 
 }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app82/HelloController.java

@@ -0,0 +1,37 @@
+/*
+ *
+ *  * 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.app82;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+
+	@PutMapping(value = "/test")
+	public ResponseEntity<?> put(
+			 String configuration,
+			 String second, PersonDTO personDTO ) {
+		return null;
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app82/PersonDTO.java

@@ -0,0 +1,60 @@
+/*
+ *
+ *  * 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.app82;
+
+public class PersonDTO {
+	private String email;
+
+	private String firstName;
+
+	private String lastName;
+
+	public PersonDTO() {
+	}
+
+	public PersonDTO(final String email, final String firstName, final String lastName) {
+		this.email = email;
+		this.firstName = firstName;
+		this.lastName = lastName;
+	}
+
+	public String getEmail() {
+		return email;
+	}
+
+	public void setEmail(final String email) {
+		this.email = email;
+	}
+
+	public String getFirstName() {
+		return firstName;
+	}
+
+	public void setFirstName(final String firstName) {
+		this.firstName = firstName;
+	}
+
+	public String getLastName() {
+		return lastName;
+	}
+
+	public void setLastName(final String lastName) {
+		this.lastName = lastName;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app82/SpringDocApp82Test.java

@@ -0,0 +1,30 @@
+/*
+ *
+ *  * 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.app82;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp82Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app8.json

@@ -11,20 +11,39 @@
     }
   ],
   "paths": {
-    "/myapi": {
-      "get": {
+    "/test": {
+      "put": {
         "tags": [
-          "my-api-controller"
+          "hello-controller"
         ],
-        "description": "Annotations from interfaces test",
-        "operationId": "get",
+        "operationId": "put",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "configuration": {
+                    "type": "string"
+                  },
+                  "second": {
+                    "type": "string"
+                  },
+                  "personDTO": {
+                    "$ref": "#/components/schemas/PersonDTO"
+                  }
+                }
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "default response",
             "content": {
               "*/*": {
                 "schema": {
-                  "type": "string"
+                  "type": "object"
                 }
               }
             }
@@ -33,5 +52,22 @@
       }
     }
   },
-  "components": {}
+  "components": {
+    "schemas": {
+      "PersonDTO": {
+        "type": "object",
+        "properties": {
+          "email": {
+            "type": "string"
+          },
+          "firstName": {
+            "type": "string"
+          },
+          "lastName": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
 }

springdoc-openapi-webmvc-core/src/test/resources/results/app82.json

@@ -0,0 +1,53 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "put": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "put",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "configuration": {
+                    "type": "string"
+                  },
+                  "second": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}