阅读 100

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


    io.github.yedaxia
    japidocs
    1.4.3

 



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); // 执行生成文档
    }
}

 

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

文章分类
代码人生
版权声明:本站是系统测试站点,无实际运营。本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 XXXXXXo@163.com 举报,一经查实,本站将立刻删除。
相关推荐