使用japidocs生成springboot api文档

路过君

发布于 2020-10-28 11:13:48

1.1K0

发布于 2020-10-28 11:13:48

文章被收录于专栏：路过君BLOG from CSDN

可用于生成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);
    }
}