2021-09-29---springboot集成japi生成API文档

springboot集成japi生成API文档

一，导入依赖包

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

二，编写生成文档类

public class JApiDocsInitialization {

    /**
     * JApi run test
     *
     * @param args
     */
    public static void main(String[] args) {
        initialize();
    }

    /**
     * 自动生成api文档
     */
    public static void initialize() {
        DocsConfig config = new DocsConfig();
        // 项目根目录
        config.setProjectPath("E:\\finance-epa-service");
        // 项目名称
        config.setProjectName("finance-epa-service");
        // 声明该API的版本
        config.setApiVersion("V1.0");
        // 生成API 文档所在目录
        config.setDocsPath("E:\\finance-epa-service\\src\\main\\resources\\static");
        // 配置自动生成
        config.setAutoGenerate(Boolean.TRUE);
        // 执行生成文档
        Docs.buildHtmlDocs(config);
    }
}

效果图如下：