大家好，我是 Java陈序员。

作为一名合格的程序员，不只代码要写好，而且文档要写好。

虽然目前有老练的结构能够快速生成接口文档，如大名鼎鼎的 Swagger.可是 Swagger 需求编写很多的注解来辅佐生成文档，侵入了事务代码。不符合高内聚、低耦合的编程规范！

今日，给大家介绍一款零侵入的 Api 接口文档生成东西！

关注微信公众号：【Java陈序员】，获取开源项目共享、AI副业共享、超200本经典计算机电子书籍等。

项目介绍

smart-doc 是一款一起支撑 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的东西。完全根据注释生成文档，做到零侵入。

smart-doc 最大的长处就在于零侵入，不采用任何注解侵入到事务代码中。

只需求依照 java-doc 标准编写注释，smart-doc 就能帮你生成一个简易明晰的文档。

smart-doc 生成的文档支撑 Markdown、Postman Collection2.0 、HTML5、OpenAPI 3.0 .

零侵入！试试这款Api接口文档生成器！

此外，smart-doc 还支撑自动推送文档到 Torna 企业级接口文档办理平台。

快速开始

1、新建 JSON 装备文件

在项目发动类地点模块的 resources 目录下创建 smart-doc.json 文件：

{
    "outPath": "/path/to/userdir"
}

outPath 指定文档输出的目录位置，也能够运用相对路径, 如: ./src/main/resources/static/doc

2、引进 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>  
            <!-- 运用了mybatis-plus的Page分页需求include所运用的源码包 -->
            <include>com.baomidou:mybatis-plus-extension</include>
            <!-- 运用了mybatis-plus的IPage分页需求include mybatis-plus-core-->
            <include>com.baomidou:mybatis-plus-core</include>
            <!-- 运用了jpa的分页需求include所运用的源码包 -->
            <include>org.springframework.data:spring-data-commons</include>             
        </includes> 
    </configuration>
    <executions>
        <execution>
            <!--假如不需求在履行编译时发动smart-doc，则将phase注释掉-->
            <phase>compile</phase>
            <goals>
                <!--smart-doc供给了html、openapi、markdown等goal，可按需装备-->
                <goal>html</goal>
            </goals>
        </execution>
    </executions>
</plugin>

假如是 Gradle 项目，同样的也需求引进插件：

plugins {
  id "com.ly.smart-doc" version "[最新版别]"
}

Gradle 项目完整装备可参考：

https://smart-doc-group.github.io/#/zh-cn/plugins/gradle

3、运用

在 IDEA 中直接运用 Maven 插件目录下的 smart-doc 模块

零侵入！试试这款Api接口文档生成器！

或许运用如下指令输出接口文档：

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

零侵入！试试这款Api接口文档生成器！

总结

不管是新项目，还是老项目，smart-doc 都完美适用。关于新项目不需求再引进其他结构和编写代码；老项目只需完善 java-doc 标准的注释，就能够快速生成接口文档，完全不影响到事务代码！

下次假如要编写接口接口文档，能够试试运用 smart-doc 一键生成~

当然了，smart-doc 也存在缺点，便是文档不是在线的，不利于共享！

针关于这一点，也有对应的解决方案，便是与企业级其他接口文档办理体系 Torna 结合。

最终，贴上项目地址：

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

最终

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

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

或许拜访网站，进行在线浏览：

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

大家的点赞、保藏和谈论都是对作者的支撑，如文章对你有帮助还请点赞转发支撑下，谢谢！