温馨提示

前面章节我们演示了如何在Springboot项目中一键启动,本章节将介绍如何在Jfinal等其它项目中使用doc-apis生成接口文档

在所有非Springboot项目中,使用易用度上会略有下降,但上手难度依然非常地小,只需要掌握高端码农必备的CV+改技能即可驾驭,下面我以spring项目为例进行演示:

首先,非springboot项目引入的坐标略有不同,无需引入starter模块,仅引入core模块即可:

Maven

        <!-- 引入doc-apis最新版本的依赖-->
        <dependency>
            <groupId>com.doc-apis</groupId>
            <artifactId>doc-apis-core</artifactId>
            <!--这里Latest Version是指最新版本的依赖,比如2.0.0,可以通过下面的图片获取-->
            <version>Latest Version</version>
            <!--下面这段可选,如果您不希望doc-apis打包进您的项目中,通过test模块启动项目自动生成接口文档也是可以的-->
            <!--<scope>test</scope>-->
        </dependency>

Gradle

compile group: 'com.doc-apis', name: 'doc-apis-core', version: 'Latest Version'

✨最新版本 Latest Version: (opens new window)

    public static void main(String[] args) {
        DocsConfig docsConfig = new DocsConfig();
        // 指定要生成项目的路径
        docsConfig.setProjectPath("E:\\doc-apis-test\\springDemo");
        // 文档版本号(可缺省)
        docsConfig.setApiVersion("V1.0");
        // 是否自动生成
        docsConfig.setAutoGenerate(Boolean.TRUE);
        // 文档生成存放的路径
        docsConfig.setDocsPath("E:\\tmp");
        // 额外生成markdown文档
        docsConfig.addPlugin(new MarkdownDocPlugin());
        // 执行生成
        Docs.buildHtmlDocs(docsConfig);
    }

不妨直接将这段代码copy至您的项目中,然后简单修改一下生成项目的路径和文档存放路径,然后运行main方法即可. 如需修改其它个性化配置,可参考参考配置章节,相关配置可以直接通过DocsConfig提供的set方法进行设置.

其它Jfinal,player等小众类型项目与spring项目使用雷同,不再重复演示.