使用japidocs生成springboot api文档

• 可用于生成spring boot api文档
• 读取JAVA DOC注释，无需额外的代码改造

基本用法

1. 添加依赖

<dependency>
  <groupId>io.github.yedaxia</groupId>
  <artifactId>japidocs</artifactId>
  <version>1.4.3</version>
</dependency>

2. 创建main函数

public class ApiDocs {
	// 项目名称
    private static final String PROJECT_NAME = "ProjectName";
    // 版本
    private static final String VERSION = "V2.0";
    // 路径
    private static final String PROJECT_PATH = "C:\\ProjectName";

    public static void main(String[] args) {
        DocsConfig config = new DocsConfig();
        config.setProjectPath(PROJECT_PATH + "\\src");
        config.setProjectName(PROJECT_NAME);
        config.setApiVersion(VERSION);
        config.setDocsPath(PROJECT_PATH + "\\docs");
        config.setAutoGenerate(Boolean.TRUE);
        Docs.buildHtmlDocs(config);
    }
}

3. 执行

将在C:\ProjectName\docs\V2.0\路径下生成文档文件
首页index.html效果如图

接口效果如图

注意

如果API的参数或返回类型中存在依赖项目中的类，会报找不到类的异常，但不影响生成，只是无法看到具体类的结构

解决办法

直接将目标项目引入作为依赖即可

参考

JApiDocs中文官网
JAVA DOC 参考