JApiDocs 极简入门

最新推荐文章于 2024-07-02 17:27:09 发布

qq_38777649

最新推荐文章于 2024-07-02 17:27:09 发布

阅读量462

点赞数 1

分类专栏： java

本文链接：https://blog.csdn.net/qq_38777649/article/details/110390726

版权

java 专栏收录该内容

28 篇文章 0 订阅

订阅专栏

本文档介绍了如何使用JApiDocs工具为Java项目自动生成API接口文档。首先，你需要在项目中引入JApiDocs的Maven依赖，然后创建配置类指定项目路径、输出目录、项目名称和版本等信息。JApiDocs会解析Controller注释生成文档。此外，你还可以通过添加MarkdownDocPlugin插件来额外生成Markdown格式的接口文档。

摘要由CSDN通过智能技术生成

JApiDocs java api接口文档

源码地址： https://github.com/YeDaxia/JApiDocs

1 、引入依赖

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

2 、创建 JApiDocs 配置

创建 TestJApiDocs 类，作为 JApiDocs 的配置，生成接口文档：

public class TestJApiDocs {

    public static void main(String[] args) {
        // 1. 创建生成文档的配置
        DocsConfig config = new DocsConfig();
        config.setProjectPath("/Users/yunai/Java/SpringBoot-Labs/lab-24/lab-24-apidoc-japidocs"); // 项目所在目录
        config.setDocsPath("/Users/yunai/Downloads/"); // 生成 HTML 接口文档的目标目录
        config.setAutoGenerate(true); // 是否给所有 Controller 生成接口文档
        config.setProjectName("示例项目"); // 项目名
        config.setApiVersion("V1.0"); // API 版本号
        config.addPlugin(new MarkdownDocPlugin()); // 使用 MD 插件，额外生成 MD 格式的接口文档
        // 2. 执行生成 HTML 接口文档
        Docs.buildHtmlDocs(config);
    }

}