前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >3秒集成API接口文档

3秒集成API接口文档

原创
作者头像
暖月寒星
修改2020-12-09 17:43:52
1.1K0
修改2020-12-09 17:43:52
举报
文章被收录于专栏:浅枫沐雪

pom添加依赖

代码语言:txt
复制
        <!--Api Doc-->
        <dependency>
            <groupId>io.github.yedaxia</groupId>
            <artifactId>japidocs</artifactId>
            <version>1.4.3</version>
        </dependency>

入口类添加配置信息

代码语言:txt
复制
    DocsConfig config = new DocsConfig();
        config.setProjectPath("D:\\Code\\test-java"); // 项目根目录
        config.setProjectName("office-website-java"); // 项目名称
        config.setApiVersion("V1.0");       // 声明该API的版本
        config.setDocsPath("D:\\apiDoc"); // 生成API 文档所在目录
        config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成
        Docs.buildHtmlDocs(config); // 执行生成文档

启动项目

在ApiDoc输出目录V1.0里面的index.html打开即可看到类似下图的接口文档

接口文档.png
接口文档.png

更多详见

https://japidocs.agilestudio.cn/#/zh-cn/

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • pom添加依赖
  • 入口类添加配置信息
  • 启动项目
  • 更多详见
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档