diff --git a/src/main/java/com/power/doc/builder/OpenApiBuilder.java b/src/main/java/com/power/doc/builder/OpenApiBuilder.java index 9dcd8df..0c2c067 100644 --- a/src/main/java/com/power/doc/builder/OpenApiBuilder.java +++ b/src/main/java/com/power/doc/builder/OpenApiBuilder.java @@ -41,7 +41,6 @@ import java.util.*; */ public class OpenApiBuilder { - //过滤url中的特殊字符 private static final String PATH_REGEX = "[/{};\\t+]"; /** @@ -95,9 +94,9 @@ public class OpenApiBuilder { } /** - * info 信息 + * Build openapi info * - * @param apiConfig 文档配置信息 + * @param apiConfig ApiConfig * @return */ private static Map buildInfo(ApiConfig apiConfig) { @@ -108,9 +107,9 @@ public class OpenApiBuilder { } /** - * server 信息 + * Build Servers * - * @param config 文档配置信息 + * @param config ApiConfig * @return */ private static List> buildServers(ApiConfig config) { @@ -122,9 +121,9 @@ public class OpenApiBuilder { } /** - * 构建path数据 url请求 + * Build openapi paths * - * @param apiDocList api列表 + * @param apiDocList List of api * @return */ private static Map buildPaths(List apiDocList) { @@ -134,7 +133,7 @@ public class OpenApiBuilder { List apiMethodDocs = a.getList(); apiMethodDocs.forEach( method -> { - //设置paths的请求url 将双斜杠替换成单斜杠 + //replace '//' to '/' String url = method.getPath().replace("//", "/"); Map request = buildPathUrls(method, a); //pathMap.put(method.getPath().replace("//", "/"), buildPathUrls(method, a)); @@ -152,10 +151,10 @@ public class OpenApiBuilder { } /** - * paths 设置url请求方式 + * Build path urls * - * @param apiMethodDoc 方法参数 - * @param apiDoc 类参数 + * @param apiMethodDoc Method + * @param apiDoc ApiDoc * @return */ private static Map buildPathUrls(ApiMethodDoc apiMethodDoc, ApiDoc apiDoc) { @@ -189,9 +188,9 @@ public class OpenApiBuilder { } /** - * 请求体构建 只针对post请求 并且请求体不为null + * Build request body * - * @param apiMethodDoc 方法参数 + * @param apiMethodDoc ApiMethodDoc * @return */ private static Map buildRequestBody(ApiMethodDoc apiMethodDoc) { @@ -199,7 +198,7 @@ public class OpenApiBuilder { boolean isPost = (apiMethodDoc.getType().equals(Methods.POST.getValue()) || apiMethodDoc.getType().equals(Methods.PUT.getValue()) || apiMethodDoc.getType().equals(Methods.PATCH.getValue())); - //如果是post请求 且包含请求体 + //add content of post method if (isPost) { requestBody.put("content", buildContent(apiMethodDoc, false)); return requestBody; diff --git a/src/main/java/com/power/doc/builder/TornaBuilder.java b/src/main/java/com/power/doc/builder/TornaBuilder.java index 94e9415..d08a1aa 100644 --- a/src/main/java/com/power/doc/builder/TornaBuilder.java +++ b/src/main/java/com/power/doc/builder/TornaBuilder.java @@ -30,12 +30,10 @@ import com.power.doc.constants.TornaConstants; import com.power.doc.factory.BuildTemplateFactory; import com.power.doc.model.ApiConfig; import com.power.doc.model.ApiDoc; -import com.power.doc.model.ApiGroup; import com.power.doc.model.torna.Apis; import com.power.doc.model.torna.TornaApi; import com.power.doc.model.torna.TornaDic; import com.power.doc.template.IDocBuildTemplate; -import com.power.doc.template.SpringBootDocBuildTemplate; import com.power.doc.utils.DocUtil; import com.power.doc.utils.TornaUtil; import com.thoughtworks.qdox.JavaProjectBuilder; @@ -93,7 +91,7 @@ public class TornaBuilder { * @param builder JavaProjectBuilder */ public static void buildTorna(List apiDocs, ApiConfig apiConfig, JavaProjectBuilder builder) { - TornaApi tornaApi = new TornaApi(); + TornaApi tornaApi = new TornaApi(); tornaApi.setAuthor(StringUtil.isEmpty(apiConfig.getAuthor()) ? System.getProperty("user.name") : apiConfig.getAuthor()); tornaApi.setIsReplace((apiConfig.getReplace() == null || apiConfig.getReplace()) ? 1 : 0); Apis api; diff --git a/src/main/java/com/power/doc/utils/TornaUtil.java b/src/main/java/com/power/doc/utils/TornaUtil.java index 45c17db..62b57a1 100644 --- a/src/main/java/com/power/doc/utils/TornaUtil.java +++ b/src/main/java/com/power/doc/utils/TornaUtil.java @@ -5,6 +5,7 @@ import com.google.gson.JsonParser; import com.power.common.model.EnumDictionary; import com.power.common.util.CollectionUtil; import com.power.common.util.StringUtil; +import com.power.doc.constants.DocGlobalConstants; import com.power.doc.constants.TornaConstants; import com.power.doc.model.*; import com.power.doc.model.rpc.RpcApiDependency; @@ -98,8 +99,12 @@ public class TornaUtil { if (CollectionUtil.isNotEmpty(apiMethodDoc.getPathParams())) { methodApi.setPathParams(buildParams(apiMethodDoc.getPathParams())); } - //formData - if (CollectionUtil.isNotEmpty(apiMethodDoc.getQueryParams())) { + + if (CollectionUtil.isNotEmpty(apiMethodDoc.getQueryParams()) + && DocGlobalConstants.MULTIPART_TYPE.equals(apiMethodDoc.getContentType())) { + // file upload + methodApi.setRequestParams(buildParams(apiMethodDoc.getQueryParams())); + } else if (CollectionUtil.isNotEmpty(apiMethodDoc.getQueryParams())) { methodApi.setQueryParams(buildParams(apiMethodDoc.getQueryParams())); } //Json