Changes report: #1743

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/AbstractRequestService.java

@@ -33,9 +33,11 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
@@ -263,6 +265,15 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 
 			if (parameterDoc == null)
 				parameterDoc = parametersDocMap.get(parameterInfo.getpName());
+
+			if (parameterDoc == null) {
+				io.swagger.v3.oas.annotations.media.Schema schema = AnnotatedElementUtils.findMergedAnnotation(
+						AnnotatedElementUtils.forAnnotations(methodParameter.getParameterAnnotations()), io.swagger.v3.oas.annotations.media.Schema.class);
+				if (schema != null) {
+					parameterDoc = parameterBuilder.generateParameterBySchema(schema);
+				}
+			}
+
 			// use documentation as reference
 			if (parameterDoc != null) {
 				if (parameterDoc.hidden() || parameterDoc.schema().hidden())
@@ -306,6 +317,28 @@ else if (!RequestMethod.GET.equals(requestMethod)) {
 		}
 
 		LinkedHashMap<String, Parameter> map = getParameterLinkedHashMap(components, methodAttributes, operationParameters, parametersDocMap);
+		RequestBody requestBody = requestBodyInfo.getRequestBody();
+		// support form-data
+		if (requestBody != null
+				&& requestBody.getContent() != null
+				&& requestBody.getContent().containsKey(org.springframework.http.MediaType.MULTIPART_FORM_DATA_VALUE)) {
+			io.swagger.v3.oas.models.media.Schema<?> mergedSchema = requestBodyInfo.getMergedSchema();
+			Iterator<Entry<String, Parameter>> it = map.entrySet().iterator();
+			while (it.hasNext()) {
+				Entry<String, Parameter> entry = it.next();
+				Parameter parameter = entry.getValue();
+				if (!ParameterIn.PATH.toString().equals(parameter.getIn())) {
+					io.swagger.v3.oas.models.media.Schema<?> itemSchema = new io.swagger.v3.oas.models.media.Schema() ;
+					itemSchema.setName(entry.getKey());
+					itemSchema.setDescription(parameter.getDescription());
+					itemSchema.setDeprecated(parameter.getDeprecated());
+					if (parameter.getExample() != null)
+						itemSchema.setExample(parameter.getExample());
+					mergedSchema.addProperty(entry.getKey(), itemSchema);
+					it.remove();
+				}
+			}
+		}
 		setParams(operation, new ArrayList<>(map.values()), requestBodyInfo);
 		return operation;
 	}

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/GenericParameterService.java

@@ -25,6 +25,7 @@
 package org.springdoc.core.service;
 
 import java.io.IOException;
+import java.lang.annotation.Annotation;
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
 import java.lang.reflect.WildcardType;
@@ -41,6 +42,9 @@
 import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.core.util.PrimitiveType;
 import io.swagger.v3.oas.annotations.enums.Explode;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.enums.ParameterStyle;
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.examples.Example;
@@ -558,4 +562,103 @@ public Object resolveEmbeddedValuesAndExpressions(String value) {
 		}
 		return exprResolver.evaluate(placeholdersResolved, this.expressionContext);
 	}
-}
+
+	/**
+	 * Generate parameter by schema
+	 *
+	 * @param schema the schema
+	 * @return the io.swagger.v3.oas.annotations.Parameter
+	 */
+	public io.swagger.v3.oas.annotations.Parameter generateParameterBySchema(io.swagger.v3.oas.annotations.media.Schema schema) {
+		return new io.swagger.v3.oas.annotations.Parameter() {
+			@Override
+			public Class<? extends Annotation> annotationType() {
+				return io.swagger.v3.oas.annotations.Parameter.class;
+			}
+			@Override
+			public String name() {
+				return schema.name();
+			}
+
+			@Override
+			public ParameterIn in() {
+				return ParameterIn.DEFAULT;
+			}
+
+			@Override
+			public String description() {
+				return schema.description();
+			}
+
+			@Override
+			public boolean required() {
+				return schema.required();
+			}
+
+			@Override
+			public boolean deprecated() {
+				return schema.deprecated();
+			}
+
+			@Override
+			public boolean allowEmptyValue() {
+				return false;
+			}
+
+			@Override
+			public ParameterStyle style() {
+				return ParameterStyle.DEFAULT;
+			}
+
+			@Override
+			public Explode explode() {
+				return Explode.DEFAULT;
+			}
+
+			@Override
+			public boolean allowReserved() {
+				return false;
+			}
+
+			@Override
+			public io.swagger.v3.oas.annotations.media.Schema schema() {
+				return schema;
+			}
+
+			@Override
+			public io.swagger.v3.oas.annotations.media.ArraySchema array() {
+				return null;
+			}
+
+			@Override
+			public io.swagger.v3.oas.annotations.media.Content[] content() {
+				return new io.swagger.v3.oas.annotations.media.Content[0];
+			}
+
+			@Override
+			public boolean hidden() {
+				return schema.hidden();
+			}
+
+			@Override
+			public ExampleObject[] examples() {
+				return new ExampleObject[0];
+			}
+
+			@Override
+			public String example() {
+				return schema.example();
+			}
+
+			@Override
+			public Extension[] extensions() {
+				return schema.extensions();
+			}
+
+			@Override
+			public String ref() {
+				return schema.ref();
+			}
+		};
+	}
+}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app189/ArticleApi.java

@@ -0,0 +1,29 @@
+package test.org.springdoc.api.v30.app189;
+
+import java.util.LinkedList;
+import java.util.List;
+
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springdoc.core.annotations.ParameterObject;
+
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestPart;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+@Tag(name = "Article Api")
+@RestController("/article")
+public class ArticleApi {
+
+    @GetMapping("query")
+    public List<ArticleDto> query(@ParameterObject ArticleQueryCondition condition) {
+        return new LinkedList<>();
+    }
+
+    @PostMapping(value = "create", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    public ArticleDto create(@ParameterObject ArticleDto dto, @RequestPart MultipartFile file) {
+        return new ArticleDto();
+    }
+}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app189/ArticleDto.java

@@ -0,0 +1,28 @@
+package test.org.springdoc.api.v30.app189;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema
+public class ArticleDto {
+    @Schema(description = "title")
+    private String title;
+
+    @Schema(description = "content")
+    private String content;
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    public String getContent() {
+        return content;
+    }
+
+    public void setContent(String content) {
+        this.content = content;
+    }
+}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app189/ArticleQueryCondition.java

@@ -0,0 +1,16 @@
+package test.org.springdoc.api.v30.app189;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+@Schema
+public class ArticleQueryCondition {
+    @Schema(description = "title")
+    private String title;
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app189/SpringDocApp189Test.java

@@ -0,0 +1,34 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2022 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.v30.app189;
+
+import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp189Test extends AbstractSpringDocV30Test {
+
+    @SpringBootApplication
+    static class SpringDocTestApp {}
+
+}