fix: fix mock escape(query, body, curl, example)

chenqi146 · Jan 1, 2024 · d234642 · d234642
1 parent 733f6c8
commit d234642
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 10 deletions.
diff --git a/pom.xml b/pom.xml
@@ -61,7 +61,7 @@
         <dependency>
             <groupId>com.github.shalousun</groupId>
             <artifactId>common-util</artifactId>
-            <version>2.2.1</version>
+            <version>2.2.2</version>
         </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>

diff --git a/src/main/java/com/ly/doc/helper/BaseHelper.java b/src/main/java/com/ly/doc/helper/BaseHelper.java
@@ -25,6 +25,7 @@
 import com.ly.doc.constants.DocTags;
 import com.ly.doc.utils.DocUtil;
 import com.ly.doc.utils.JavaClassValidateUtil;
+import com.power.common.util.StringEscapeUtil;
 import com.power.common.util.StringUtil;
 import com.ly.doc.utils.ParamUtil;
 
@@ -37,13 +38,15 @@ protected static String getFieldValueFromMock(String subTypeName, Map<String, St
         String fieldValue = "";
         if (tagsMap.containsKey(DocTags.MOCK) && StringUtil.isNotEmpty(tagsMap.get(DocTags.MOCK))) {
             fieldValue = tagsMap.get(DocTags.MOCK);
+            fieldValue = StringEscapeUtil.unescapeJava(fieldValue);
             if (!DocUtil.javaPrimaryType(typeSimpleName)
                 && !JavaClassValidateUtil.isCollection(subTypeName)
                 && !JavaClassValidateUtil.isMap(subTypeName)
                 && !JavaClassValidateUtil.isArray(subTypeName)) {
+                fieldValue = StringEscapeUtil.escapeJava(fieldValue, true);
                 fieldValue = DocUtil.handleJsonStr(fieldValue);
             }
         }
-        return ParamUtil.formatMockValue(fieldValue);
+        return fieldValue;
     }
 }
diff --git a/src/main/java/com/ly/doc/helper/ParamsBuildHelper.java b/src/main/java/com/ly/doc/helper/ParamsBuildHelper.java
@@ -41,6 +41,7 @@
 import com.ly.doc.utils.JavaClassValidateUtil;
 import com.power.common.model.EnumDictionary;
 import com.power.common.util.CollectionUtil;
+import com.power.common.util.StringEscapeUtil;
 import com.power.common.util.StringUtil;
 import com.ly.doc.builder.ProjectDocConfigBuilder;
 import com.ly.doc.constants.DocTags;
@@ -66,6 +67,14 @@
  */
 public class ParamsBuildHelper extends BaseHelper {
 
+    protected static String getFieldValueFromMock(Map<String, String> tagsMap) {
+        String fieldValue = "";
+        if (tagsMap.containsKey(DocTags.MOCK) && StringUtil.isNotEmpty(tagsMap.get(DocTags.MOCK))) {
+            fieldValue = StringEscapeUtil.unescapeJava(tagsMap.get(DocTags.MOCK));
+        }
+        return fieldValue;
+    }
+
     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) {
@@ -248,7 +257,8 @@ public static List<ApiParam> buildParams(String className, String pre, int level
                     }
                 }
                 comment.append(JavaFieldUtil.getJsrComment(javaAnnotations));
-                String fieldValue = getFieldValueFromMock(subTypeName, tagsMap, typeSimpleName);
+                // fixme post form curl example error
+                String fieldValue = getFieldValueFromMock(tagsMap);
 
 
                 // cover response value

diff --git a/src/main/java/com/ly/doc/template/IRestDocTemplate.java b/src/main/java/com/ly/doc/template/IRestDocTemplate.java
@@ -1012,7 +1012,6 @@ default ApiRequestExample buildReqJson(DocJavaMethod javaMethod, ApiMethodDoc ap
             path = DocUtil.formatAndRemove(path, pathParamsMap);
             body = UrlUtil.urlJoin(DocGlobalConstants.EMPTY, queryParamsMap)
                     .replace("?", DocGlobalConstants.EMPTY);
-            body = StringUtil.removeQuotes(body);
             url = apiMethodDoc.getServerUrl() + "/" + path;
             url = UrlUtil.simplifyUrl(url);
 

diff --git a/src/main/java/com/ly/doc/utils/ApiParamTreeUtil.java b/src/main/java/com/ly/doc/utils/ApiParamTreeUtil.java
@@ -31,7 +31,6 @@
 import com.ly.doc.model.ApiParam;
 import com.ly.doc.model.ApiReqParam;
 import com.power.common.util.CollectionUtil;
-import com.power.common.util.StringUtil;
 
 /**
  * @author yu 2020/8/8.
@@ -102,7 +101,6 @@ public static ApiMethodReqParam buildMethodReqParam(List<ApiParam> paramList, fi
         List<ApiParam> queryParams = new ArrayList<>();
         List<ApiParam> bodyParams = new ArrayList<>();
         for (ApiParam param : paramList) {
-            param.setValue(StringUtil.removeDoubleQuotes(param.getValue()));
             if (param.isPathParam()) {
                 if (pathReqParamMap.containsKey(param.getField())) {
                     param.setConfigParam(true).setValue(pathReqParamMap.get(param.getField()).getValue());

diff --git a/src/main/java/com/ly/doc/utils/CurlUtil.java b/src/main/java/com/ly/doc/utils/CurlUtil.java
@@ -74,11 +74,11 @@ public static String toCurl(CurlRequest request) {
 
         sb.append(" -i");
         // append request url
-        sb.append(" ").append(request.getUrl());
-        if (StringUtil.isNotEmpty(request.getBody()) &&
-                !DocGlobalConstants.URL_CONTENT_TYPE.equals(request.getContentType())) {
+        sb.append(" ").append("'").append(request.getUrl()).append("'");
+        if (StringUtil.isNotEmpty(request.getBody())) {
             sb.append(" --data");
-            sb.append(" '").append(request.getBody()).append("'");
+            String data = request.getBody().replaceAll("'", "'\\\\''");
+            sb.append(" '").append(data).append("'");
         }
         return sb.toString();
     }