Merge pull request #864 from linwumingshi/feature/requestPart

Feature/request part

Author: shalousun

src/main/java/com/ly/doc/constants/FormDataContentTypeEnum.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) 2018-2024 smart-doc
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://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 com.ly.doc.constants;
+
+/**
+ * Enum representing Content-Type values for form-data in POST requests.
+ *
+ * @see <a href=
+ * "https://swagger.io/docs/specification/describing-request-body/multipart-requests/">
+ * Specifying Content-Type</a>
+ * @author linwumingshi
+ * @since 3.0.7
+ */
+public enum FormDataContentTypeEnum {
+
+	/**
+	 * application/json: Complex values or arrays of complex values.
+	 */
+	APPLICATION_JSON("application/json"),
+
+	/**
+	 * text/plain: Primitive values or arrays of primitive values.
+	 */
+	TEXT_PLAIN("text/plain"),
+
+	/**
+	 * application/octet-stream: Binary or base64 encoded strings.
+	 */
+	APPLICATION_OCTET_STREAM("application/octet-stream");
+
+	/**
+	 * The Content-Type value.
+	 */
+	private final String value;
+
+	/**
+	 * Constructor to set the Content-Type value.
+	 * @param value the Content-Type value
+	 */
+	FormDataContentTypeEnum(String value) {
+		this.value = value;
+	}
+
+	/**
+	 * Returns the Content-Type value.
+	 * @return the Content-Type value
+	 */
+	public String getValue() {
+		return value;
+	}
+
+}

src/main/java/com/ly/doc/constants/SpringMvcRequestAnnotationsEnum.java

@@ -24,6 +24,8 @@
 import java.util.List;
 
 /**
+ * spring mvc request annotation enum
+ *
  * @author yu 2019/12/20.
  */
 public enum SpringMvcRequestAnnotationsEnum {
@@ -66,7 +68,19 @@ public enum SpringMvcRequestAnnotationsEnum {
 	/**
 	 * SpringMvc RequestAnnotation RequestHeader fully
 	 */
-	REQUEST_HERDER_FULLY("org.springframework.web.bind.annotation.RequestHeader"),;
+	REQUEST_HERDER_FULLY("org.springframework.web.bind.annotation.RequestHeader"),
+
+	/**
+	 * SpringMvc RequestAnnotation RequestPart
+	 */
+	REQUEST_PART("RequestPart"),
+
+	/**
+	 * SpringMvc RequestAnnotation RequestPart fully
+	 */
+	REQUEST_PART_FULLY("org.springframework.web.bind.annotation.RequestPart"),
+
+	;
 
 	/**
 	 * SpringMvc RequestAnnotation value

src/main/java/com/ly/doc/helper/ParamsBuildHelper.java

@@ -45,6 +45,26 @@
  */
 public class ParamsBuildHelper extends BaseHelper {
 
+	/**
+	 * Builds a parameter list based on field information.
+	 * @param className The name of the generic type.
+	 * @param pre A prefix builder for nested fields.
+	 * @param level The next level of nesting.
+	 * @param isRequired Indicates whether the parameter is required.
+	 * @param isResp Indicates whether the parameter is a response parameter.
+	 * @param registryClasses A collection of registered classes.
+	 * @param projectBuilder A project builder instance.
+	 * @param groupClasses A collection of grouped classes.
+	 * @param pid The parent ID of the field.
+	 * @param jsonRequest The JSON request object.
+	 * @param atomicInteger An AtomicInteger for ID generation.
+	 * <p>
+	 * This method handles various types of fields and their values, including handling
+	 * self-referential loops, maps, arrays, objects, and primitive types. It adds
+	 * parameters to the paramList based on the type and structure of the given field,
+	 * recursively calling itself for nested or complex types.
+	 * @return A List of ApiParam instances representing the built parameters.
+	 */
 	public static List<ApiParam> buildParams(String className, String pre, int level, String isRequired, boolean isResp,
 			Map<String, String> registryClasses, ProjectDocConfigBuilder projectBuilder, Set<String> groupClasses,
 			int pid, boolean jsonRequest, AtomicInteger atomicInteger) {
@@ -384,7 +404,7 @@ else if (DocAnnotationConstants.JSON_FORMAT.equals(simpleAnnotationName)) {
 					for (int j = 0; j < level; j++) {
 						preBuilder.append(DocGlobalConstants.FIELD_SPACE);
 					}
-					preBuilder.append("└─");
+					preBuilder.append(DocGlobalConstants.PARAM_PREFIX);
 					int fieldPid;
 					ApiParam param = ApiParam.of()
 						.setField(pre + fieldName)
@@ -664,7 +684,7 @@ private static List<ApiParam> buildMapParam(String[] globGicName, String pre, in
 		for (int j = 0; j < level; j++) {
 			preBuilder.append(DocGlobalConstants.FIELD_SPACE);
 		}
-		preBuilder.append("└─");
+		preBuilder.append(DocGlobalConstants.PARAM_PREFIX);
 		paramList.addAll(buildParams(globGicName[1], preBuilder.toString(), ++nextLevel, isRequired, isResp,
 				registryClasses, projectBuilder, groupClasses, pid, jsonRequest, atomicInteger));
 		return paramList;

src/main/java/com/ly/doc/model/FormData.java

@@ -20,21 +20,46 @@
  */
 package com.ly.doc.model;
 
+import com.ly.doc.constants.FormDataContentTypeEnum;
+
 /**
+ * form data class
+ *
  * @author xingzi 2019/12/21 20:20
  */
 public class FormData {
 
+	/**
+	 * key
+	 */
 	private String key;
 
+	/**
+	 * type
+	 */
 	private String type;
 
+	/**
+	 * description
+	 */
 	private String description;
 
+	/**
+	 * source
+	 */
 	private Object src;
 
+	/**
+	 * value
+	 */
 	private String value;
 
+	/**
+	 * contentType eg: `application/json`,when the param has annotation `@RequestPart`
+	 * @see FormDataContentTypeEnum
+	 */
+	private String contentType;
+
 	/**
 	 * openapi items
 	 */
@@ -89,6 +114,18 @@ public void setDescription(String description) {
 		this.description = description;
 	}
 
+	public String getContentType() {
+		return contentType;
+	}
+
+	public void setContentType(FormDataContentTypeEnum contentType) {
+		this.contentType = contentType.getValue();
+	}
+
+	public void setContentType(String contentType) {
+		this.contentType = contentType;
+	}
+
 	@Override
 	public String toString() {
 		return "FormData{" + "key='" + key + '\'' + ", type='" + type + '\'' + ", description='" + description + '\''

src/main/java/com/ly/doc/model/request/CurlRequest.java

@@ -20,26 +20,46 @@
  */
 package com.ly.doc.model.request;
 
-import java.util.List;
-
 import com.ly.doc.model.ApiReqParam;
 import com.ly.doc.model.FormData;
 
+import java.util.List;
+
 /**
+ * curl request
+ *
  * @author yu 2020/12/21.
  */
 public class CurlRequest {
 
+	/**
+	 * Http method
+	 */
 	private String type;
 
+	/**
+	 * Request headers
+	 */
 	private List<ApiReqParam> reqHeaders;
 
+	/**
+	 * Request file form data
+	 */
 	private List<FormData> fileFormDataList;
 
+	/**
+	 * Request url
+	 */
 	private String url;
 
+	/**
+	 * Request body
+	 */
 	private String body;
 
+	/**
+	 * Content-Type
+	 */
 	private String contentType;
 
 	public static CurlRequest builder() {