SpringBoot(8)japidocs构建接口文档

邱秋Elena

已于 2023-04-03 11:37:10 修改

阅读量206

点赞数

文章标签： spring boot spring java

于 2023-03-31 16:04:19 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_38380811/article/details/129881799

版权

文章介绍了如何在SpringBoot项目中集成Japidocs来生成API文档。首先，需在项目中添加Japidocs的依赖。接着，在Controller层的方法上添加必要的注释以描述参数和返回值。最后，通过配置DocsConfig类的各个属性，如项目路径、文档生成路径等，运行main方法来生成HTML离线文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、添加依赖

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

二、controller层注释

 /**
     * 两个参数的swagger例子,两个参数
     * @param one 第一个参数注释
     * @param two 第二个参数注释
     * @return
     */

三、使用

在测试类中运行main方法,生成html离线文档,在本地运行项目时可以直接当方法写在springboot的启动类中

public static void main(String[] args) {
      DocsConfig config = new DocsConfig();
        config.setProjectPath("D:\\workSpace\\idea\\sbtest1"); // root project path
        config.setProjectName("项目名称"); // project name
        config.setApiVersion("V1.0");       // api version
        config.setDocsPath("D:\\workSpace\\idea\\sbtest1\\apidoc"); // api docs target path
        config.setAutoGenerate(Boolean.TRUE);  // auto generate
        Docs.buildHtmlDocs(config); // execute to generate
}