Get Start

快速开始

只需要配置要扫描的项目路径以及文档的输出路径即可.

      String realPath = "/Volumes/doc/projects/java/api";
      Config config = new Config();
      config.setPackageName(realPath);
      config.setDocName("xxx接口文档");
      config.setGradle(true);
      config.setGradlePath("");
      Parser parser = new SpringParser(config);
      ApiTree apiTree = parser.parse(config.getPackageName(),true);
      Generator generator = new HtmlGenerator();
      generator.from(apiTree,config);

详细说明:

public class Config {

    /**
     *  package name
     */
    private String packageName;

    /**
     * the path to store the generated docs
     *
     * default is src/static/
     */
    private String outPath = "src/static/";

    /**
     *  the path of classes files
     */
    private String classPath;

    /**
     *  api doc name  -  xxx 接口文档
     */
    private String docName;

}

config 内的字段解释:

• packageName 带扫描的文件路径 `src`上一层

• classPath class 文件路径，由于要是有类加载器所以要指定编译过的 classes 文件路径，默认是 ${packageName}/out/production/classes

• outPath 生成文档的地址，默认是本项目的 "src/static/" 文件夹

• docName 生成的接口文档名称

常见问题

javaparser 包的下载

详见 [javaparser](https://github.com/hsjfans/api-doc/wiki/JavaParser)

jar 包问题

由于目前还未支持对 jar`包内文件的读入，所以类加载时，可能会报`ClassNotFoundException,这个预计下个迭代后处理掉。

javaDocTag 问题

自定义的 javaDocTag，详见

[JavaDocTag](https://github.com/hsjfans/api-doc/wiki/JavaDocTag)