wanjia950611
/
smart-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

修改requestAdvice请求样例丢失问题

This commit is contained in:
Forget 2021-05-05 20:20:34 +08:00
parent f4869361ef
commit 302e12b03e
6 changed files with 55 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/main/java/com/power/doc/builder/rpc/RpcTornaBuilder.java
View File

@ -72,6 +72,7 @@ public class RpcTornaBuilder {
.setAuthor(a.getAuthor())
.setProtocol(a.getProtocol())
.setVersion(a.getVersion())
.setDependency(TornaUtil.buildDependencies(apiConfig.getRpcApiDependencies()))
.setInterfaceName(a.getName()));
apisList.add(api);
}

9
src/main/java/com/power/doc/model/rpc/RpcApiDependency.java
View File

@ -63,4 +63,13 @@ public class RpcApiDependency {
this.version = version;
return this;
}
@Override
public String toString() {
return "<dependency>"+"\r"+
"\t"+"<groupId>" + groupId + "</groupId>" +"\n"+
"\t"+"<artifactId>" + artifactId + "</artifactId>" +"\n"+
"\t"+ "<version>" + version + "</version>" +""+
"\r"+"</dependency>";
}
}

11
src/main/java/com/power/doc/template/SpringBootDocBuildTemplate.java vendored
View File

@ -369,10 +369,7 @@ public class SpringBootDocBuildTemplate implements IDocBuildTemplate<ApiDoc> {
&& Objects.isNull(method.getTagByName(IGNORE_REQUEST_BODY_ADVICE))) {
String requestBodyAdvice = configBuilder.getApiConfig().getRequestBodyAdvice().getClassName();
typeName = configBuilder.getApiConfig().getRequestBodyAdvice().getClassName();
gicTypeName = new StringBuffer()
.append(requestBodyAdvice)
.append("<")
.append(gicTypeName).append(">").toString();
gicTypeName = requestBodyAdvice + "<" + gicTypeName + ">";
}
@ -661,6 +658,12 @@ public class SpringBootDocBuildTemplate implements IDocBuildTemplate<ApiDoc> {
throw new RuntimeException("You have use @RequestBody Passing multiple variables for method "
+ javaMethod.getName() + " in " + className + ",@RequestBody annotation could only bind one variables.");
}
if (Objects.nonNull(builder.getApiConfig().getRequestBodyAdvice())
&& Objects.isNull(javaMethod.getTagByName(IGNORE_REQUEST_BODY_ADVICE))) {
String requestBodyAdvice = builder.getApiConfig().getRequestBodyAdvice().getClassName();
fullTypeName = typeName = requestBodyAdvice + "<" + typeName + ">";
}
requestBodyCounter++;
isRequestBody = true;
}

3
src/main/java/com/power/doc/utils/JavaClassUtil.java
View File

@ -508,7 +508,8 @@ public class JavaClassUtil {
c = c.getSuperclass();
}
} catch (ClassNotFoundException e) {
e.printStackTrace();
e.getMessage();
return false;
}
return false;
}

14
src/main/java/com/power/doc/utils/TornaUtil.java
View File

@ -6,6 +6,7 @@ import com.power.common.util.CollectionUtil;
import com.power.common.util.StringUtil;
import com.power.doc.constants.TornaConstants;
import com.power.doc.model.*;
import com.power.doc.model.rpc.RpcApiDependency;
import com.power.doc.model.torna.*;
import org.apache.commons.lang3.StringUtils;
@ -38,7 +39,7 @@ public class TornaUtil {
return hasDebugEnv;
}
public static void printDebugInfo(ApiConfig apiConfig , String responseMsg, Map<String, String> requestJson) {
public static void printDebugInfo(ApiConfig apiConfig, String responseMsg, Map<String, String> requestJson) {
if (apiConfig.isTornaDebug()) {
String sb = "配置信息列表: \n" +
"OpenUrl: " +
@ -270,4 +271,15 @@ public class TornaUtil {
}
return bodies;
}
public static String buildDependencies(List<RpcApiDependency> dependencies) {
StringBuilder s = new StringBuilder();
if (CollectionUtil.isNotEmpty(dependencies)) {
for (RpcApiDependency r : dependencies) {
s.append(r.toString())
.append("\n\n");
}
}
return s.toString();
}
}

35
src/test/java/com/power/doc/ApiDocTest.java
View File

@ -5,8 +5,11 @@ import com.power.doc.builder.HtmlApiDocBuilder;
import com.power.doc.builder.OpenApiBuilder;
import com.power.doc.builder.PostmanJsonBuilder;
import com.power.doc.builder.TornaBuilder;
import com.power.doc.builder.rpc.RpcHtmlBuilder;
import com.power.doc.builder.rpc.RpcTornaBuilder;
import com.power.doc.enums.OrderEnum;
import com.power.doc.model.*;
import com.power.doc.model.rpc.RpcApiDependency;
import org.junit.Test;
import java.io.UnsupportedEncodingException;
@ -30,15 +33,15 @@ public class ApiDocTest {
list.add("aa");
list.contains("aa");
ApiConfig config = new ApiConfig();
config.setServerUrl("http://localhost:8080");
config.setServerUrl("http://127.0.0.1:8899");
//config.setStrict(true);
config.setOpenUrl("http://torna.opensphere.cn/api/");
config.setOpenUrl("http://127.0.0.1:8899/api");
config.setAppKey("20201216788835306945118208");
config.setAppToken("2f9a7d3858a147b7845ebb48785d4dc7");
config.setAppToken("c16931fa6590483fb7a4e85340fcbfef");
config.setSecret("W.ZyGMOB9Q0UqujVxnfi@.I#V&tUUYZR");
config.setDebugEnvName("测试环境");
config.setDebugEnvUrl("http://127.0.0.1");
config.setTornaDebug(true);
//config.setTornaDebug(true);
config.setAllInOne(true);
config.setOutPath("d:\\md3");
@ -51,7 +54,7 @@ public class ApiDocTest {
//SourcePath.path().setPath("F:\\Personal\\project\\smart\\src\\main\\java")
//SourcePath.path().setDesc("加载项目外代码").setPath("E:\\ApplicationPower\\ApplicationPower\\Common-util\\src\\main\\java")
);
config.setPackageFilters("com.power.doc.controller.UserController");
config.setPackageFilters("com.power.doc.dubbo.*");
config.setDataDictionaries(
ApiDataDictionary.builder().setTitle("订单字典").setEnumClass(OrderEnum.class).setCodeField("code").setDescField("desc")
);
@ -78,23 +81,31 @@ public class ApiDocTest {
);
config.setPackageFilters("com.power.doc.controller.UserController");
config.setPackageFilters("com.power.doc.dubbo.*,com.power.doc.controller.UserController");
//非必须只有当setAllInOne设置为true时文档变更记录才生效，https://gitee.com/sunyurepository/ApplicationPower/issues/IPS4O
config.setRevisionLogs(
RevisionLog.builder().setRevisionTime("2018/12/15").setAuthor("chen").setRemarks("测试").setStatus("创建").setVersion("V1.0"),
RevisionLog.builder().setRevisionTime("2018/12/16").setAuthor("chen2").setRemarks("测试2").setStatus("修改").setVersion("V2.0")
);
// config.setResponseBodyAdvice(ResponseBodyAdvice.builder()
// .setDataField("data")
// .setDataField("dadada")
// .setClassName("com.power.common.model.CommonResult"));
config.setResponseBodyAdvice(BodyAdvice.builder()
.setDataField("data")
.setDataField("dadada")
.setClassName("com.power.common.model.CommonResult"));
config.setRequestBodyAdvice(BodyAdvice.builder()
.setDataField("data")
.setDataField("dadada")
.setClassName("com.power.common.model.CommonResult"));
config.setRpcApiDependencies(RpcApiDependency.builder().setGroupId("com.test").setArtifactId("test1").setVersion("1.0"),
RpcApiDependency.builder().setGroupId("com.smart").setArtifactId("test").setVersion("1.1.1")
);
long start = System.currentTimeMillis();
//TornaBuilder.buildApiDoc(config);
//OpenApiBuilder.buildOpenApi(config);
HtmlApiDocBuilder.buildApiDoc(config);
//RpcTornaBuilder.buildApiDoc(config);
TornaBuilder.buildApiDoc(config);
// RpcHtmlBuilder.buildApiDoc(config);
long end = System.currentTimeMillis();
DateTimeUtil.printRunTime(end, start);
}