springboot 之自动生成接口文档工具JApiDocs

￡神魔★判官ぃ 2022-12-25 10:58 258阅读 0赞

### JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具 ###

#### 简易使用方法 ####

##### 1.添加依赖 #####

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

##### 2. 参数配置 #####

在main函数中添加如下代码

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);  // 配置自动生成
    Docs.buildHtmlDocs(config); // 执行生成文档

##### 3.执行main函数，查看文档 #####

我自己的代码

//类1
    @Data
    public class UserVO { 
        private Integer age;    //用户年龄
        private String  name;   //姓名
    }
    
    //类2
    /** * 测试APIdoc */
    @RestController
    @RequestMapping(value = "testapi")
    public class TestController { 
    
        /** * GET测试 */
        @GetMapping(value = "testGET")
        public UserVO testGET(){ 
            UserVO userVO = new UserVO();
            userVO.setAge(12);
            userVO.setName("小明");
            return  userVO;
        }
    
    
        /** * POST测试 * @param userinfo */
        @PostMapping(value = "testPOST")
        public String testPOST(@RequestBody UserVO userinfo){ 
            return "post";
        }
    
        /** * 测试POST没有注解 * @param param * @return */
        @PostMapping(value = "testPOSTNO", produces = "application/json")
        public int testPOSTnoAno(String param){ 
            return 3;
        }
    
        public void test(){ 
            System.out.println("000000");
        }
    }
    
    //main函数
        public static void main(String[] args) { 
            SpringApplication.run(DemoApplication.class, args);
            DocsConfig config = new DocsConfig();
            config.setProjectPath("D:\\ProgramSoft\\IDEA\\java_project\\apidoc"); // 项目根目录
            config.setProjectName("demo"); // 项目名称
            config.setApiVersion("V1.0");       // 声明该API的版本
            config.setDocsPath("D:\\ProgramSoft\\IDEA\\java_project\\apidoc"); // 生成API 文档所在目录
            config.addPlugin(new MarkdownDocPlugin());
            config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成
            Docs.buildHtmlDocs(config); // 执行生成文档
        }

结果展示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTM5MTkxNTM_size_16_color_FFFFFF_t_70]

在IDEA下正常写代码，注释好方法即可.

当然，以上是简易版的，如果想控制更详细参数，建议读一下中文介绍，也不多  
[**中文介绍**][Link 1]

在此对作者表示感谢，方便了整理文档

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTM5MTkxNTM_size_16_color_FFFFFF_t_70]: /images/20221120/907e1b6cf03748909b109ebba986d379.png
[Link 1]: https://japidocs.agilestudio.cn/#/zh-cn/