1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.mortals;
import com.power.common.enums.HttpCodeEnum;
import com.power.common.util.DateTimeUtil;
import com.power.doc.builder.ApiDocBuilder;
import com.power.doc.builder.HtmlApiDocBuilder;
import com.power.doc.constants.DocGlobalConstants;
import com.power.doc.model.ApiConfig;
import com.power.doc.model.ApiErrorCode;
import org.junit.Test;
import java.util.ArrayList;
import java.util.List;
/**
* @author: zxfei
* @date: 2021/8/24 16:22
* @description:
**/
public class TestDoc {
/**
* 包括设置请求头，缺失注释的字段批量在文档生成期使用定义好的注释
*/
@Test
public void testBuilderControllersApi() {
ApiConfig config = new ApiConfig();
config.setServerUrl("http://localhost:28080");
config.setAllInOne(true);
config.setOutPath(DocGlobalConstants.HTML_DOC_OUT_PATH);
//com/mortals/xhx/daemon/demo/RequestDispatchController.java
config.setPackageFilters("com.mortals.xhx.busiz.WxOneThingApiController");
//config.setPackageFilters("com.mortals.xhx.daemon.demo.RequestDispatchController");
config.setShowAuthor(false);
config.setCoverOld(true);
config.setStrict(false);
config.setDisplayActualType(false);
long start = System.currentTimeMillis();
List<ApiErrorCode> errorCodeList = new ArrayList<>();
for (HttpCodeEnum codeEnum : HttpCodeEnum.values()) {
ApiErrorCode errorCode = new ApiErrorCode();
errorCode.setValue(codeEnum.getCode()).setDesc(codeEnum.getMessage());
errorCodeList.add(errorCode);
}
//不需要显示错误码,则可以不用设置错误码。
config.setErrorCodes(errorCodeList);
//生成Markdown文件
HtmlApiDocBuilder.buildApiDoc(config);
ApiDocBuilder.buildApiDoc(config);
long end = System.currentTimeMillis();
DateTimeUtil.printRunTime(end, start);
}
}