零侵入！轻松生成API接口文档的利器！

项目介绍

smart-doc是一款可用于生成JAVA REST API和Apache Dubbo RPC接口文档的工具。它完全基于注释生成文档，实现了零侵入。

功能特性

• 支持JAVA REST API和Apache Dubbo RPC接口文档生成

• 基于注释，零侵入

• 支持生成Markdown、Postman Collection2.0+、HTML5、OpenAPI 3.0+格式的文档

• 支持自动推送文档到Torna企业级接口文档管理平台

快速开始

新建JSON配置文件：在项目启动类所在模块的resources目录下创建smart-doc.json文件，指定文档输出目录位置。

<code>{ "outPath": "/path/to/userdir" }</code>

引入Maven插件依赖，在pom.xml中配置smart-doc-maven-plugin插件。

<code><!-- Maven插件依赖配置 --> <plugin> <groupId>com.ly.smart-doc</groupId> <artifactId>smart-doc-maven-plugin</artifactId> <version>[最新版本]</version> <configuration> <configFile>./src/main/resources/smart-doc.json</configFile> <projectName>${project.description}</projectName> <includes> <!-- 需要include的源码包 --> <include>com.baomidou:mybatis-plus-extension</include> <include>com.baomidou:mybatis-plus-core</include> <include>org.springframework.data:spring-data-commons</include> </includes> </configuration> <executions> <execution> <phase>compile</phase> <goals> <!-- 可配置html、openapi、markdown等goal --> <goal>html</goal> </goals> </execution> </executions> </plugin></code>

使用smart-doc，在IDEA中直接使用Maven插件目录下的smart-doc模块，或者使用命令行输出接口文档。<code>mvn -Dfile.encoding=UTF-8 smart-doc:html mvn -Dfile.encoding=UTF-8 smart-doc:markdown mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest</code>

总结

smart-doc是一款适用于新老项目的智能文档生成器，无需引入其他框架和编写代码，只需完善java-doc标准的注释，即可快速生成接口文档，完全不影响业务代码。不过，它的文档生成方式并非在线的，不便于分享。针对这一点，可与企业级接口文档管理系统Torna结合使用。

项目地址

GitHub: https://github.com/TongchengOpenSource/smart-doc

最后

推荐的开源项目已经收录到GitHub项目，欢迎Star：

https://github.com/chenyl8848/great-open-source-project

或者访问网站，进行在线浏览：

https://chencoding.top:8090/#/