document-genteration
基于Swagger自动生成接口文档，生成格式为MarkDown，后续会支持更多格式
使用方法
添加maven依赖
<dependency>
<groupId>com.github.chuanzh</groupId>
<artifactId>document-generation</artifactId>
<version>1.0.2</version>
</dependency>代码使用示例
DocAutoGenerator docAutoGenerator = new DocAutoGenerator();
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir("D:/doc/"); //输出目录
globalConfig.setPackagePath("com.github.chuanzh.controller"); //controller包目录
globalConfig.setInclude(new String[]{"UserController","AccountController"}); // 为空生成所有
globalConfig.setOpen(true); //生成完文档后打开目录
docAutoGenerator.setGlobalConfig(globalConfig);
docAutoGenerator.execute();文档展示
更多
- 后续会支持HTML、word等更多格式
- 支持请求、返回参数自定义过滤规则
- 支持自定义模板
- ...
欢迎使用并提供宝贵的意见，也欢迎你一起参与开发
联系邮箱：[email protected]