水星的随笔

背景

1. 不愿意写了Java代码，再写一遍文档。
2. 不愿意用swagger，希望生成md或者pdf文档。

初体验

pom依赖

        <dependency>
            <groupId>com.github.shalousun</groupId>
            <artifactId>smart-doc</artifactId>
            <version>2.1.3</version>
            <scope>test</scope>
        </dependency>

使用

import org.junit.Test;

import com.power.common.util.DateTimeUtil;
import com.power.doc.builder.ApiDocBuilder;
import com.power.doc.model.ApiConfig;

public class ApiDocTest {
    /**
     * 包括设置请求头，缺失注释的字段批量在文档生成期使用定义好的注释
     */
    @Test
    public void testBuilderControllersApi() {
        ApiConfig config = new ApiConfig();
        config.setServerUrl("http://localhost:8080");

        //true会严格要求注释，推荐设置true
        config.setStrict(false);

        //true会将文档合并导出到一个markdown
        //config.setAllInOne(true);

        //生成html时加密文档名不暴露controller的名称
        config.setMd5EncryptedHtmlName(true);

        //指定文档输出路径
        //@since 1.7 版本开始，选择生成静态html doc文档可使用该路径：DocGlobalConstants.HTML_DOC_OUT_PATH;
        config.setOutPath("/tmp/d1");

        // @since 1.2,如果不配置该选项，则默认匹配全部的controller,
        // 如果需要配置有多个controller可以使用逗号隔开
        config.setPackageFilters("com.abeffect");

        config.setRecursionLimit(100);

        long start = System.currentTimeMillis();

        //获取接口数据后自行处理
        ApiDocBuilder.buildApiDoc(config);
        long end = System.currentTimeMillis();
        DateTimeUtil.printRunTime(end, start);
    }
}