首页 > Windows开发 > 详细

api接口文档生成,无需其他配置一键生成基于文本注释

时间:2021-07-14 12:03:17      阅读:18      评论:0      收藏:0      [点我收藏+]
<dependency>
    <groupId>io.github.yedaxia</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.4.3</version>
</dependency>

 



import io.github.yedaxia.apidocs.Docs;
import io.github.yedaxia.apidocs.DocsConfig;

public class ApiDocsTest{

    /**
     * 接口文档生成
     */
    public static void main(String[] args) {
        DocsConfig config = new DocsConfig();
        config.setProjectPath("your springboot project path"); // 项目根目录
        config.setProjectName("ProjectName"); // 项目名称
        config.setApiVersion("V1.0");       // 声明该API的版本
        config.setDocsPath("your api docs path"); // 生成API 文档所在目录
        config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成
        //指定生成接口文档的路径
        config.setDocsPath ("D:/MyDocuments/wangyong77/桌面/docs");
        //项目根路径
        config.setProjectPath (System.getProperty("user.dir"));
        Docs.buildHtmlDocs(config); // 执行生成文档
    }
}

 

api接口文档生成,无需其他配置一键生成基于文本注释

原文:https://www.cnblogs.com/sunny-miss/p/15009812.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!