分享一个java微服务文档生成工具

本来swagger就可以生成文档，但是不能导出markdown文件，这个文档生成器是用来生成markdown文件的。

代码仓库地址：https://gitee.com/luoye_lj/restful-doc

工具整体分3个部分，分别是包扫描建立数据结构、文档模板以及根据文档模板和数据结构生成文档 。数据结构按restful结构分为：接口组、接口、请求数据、响应数据。 接口组对应一个controller文件，接口对应controller里面的方法

使用方式

1. 从仓库中拉取代码
2. 执行maven的install命令进行安装
3. 在项目中添加依赖

<dependency>
        <groupId>com.luoye.restful</groupId>
        <artifactId>RestfulDoc</artifactId>
        <version>1.0.0</version>
    </dependency>

4. 编写生成代码

package com.luoye;

import com.luoye.restful.DocBuilder;
import com.luoye.restful.PackageScanner;
import com.luoye.restful.model.ApiGroup;

import java.util.List;

public class Test {
    
    

    public static void main(String[] args) {
    
    
        PackageScanner packageScanner=new PackageScanner();
        packageScanner.setScanPackage("com.luoye.test");
        List<ApiGroup> apiGroupList =packageScanner.scan();
        DocBuilder docBuilder=new DocBuilder("测试api文档","api test doc",apiGroupList);
        docBuilder.build();
    }
}

ps

可以新建一个模板目录将原来的模板拷贝进去进行修改，然后在生成代码中指定模板目录路径