idea导出可执行jar包-这个国产开源项目帮你一键生成API文档!真香！

大家好，我是小金！今天推荐一个可以让你快速生成API文档的国产开源项目！

开发小伙伴们对 API 文档想必非常的熟悉了，不管是用公司单独维护的文档工具，还是使用比较多的 Swagger，这类文档生成工具对代码的侵入性强，在后期的修改和维护带来不少的烦恼。

今天就给大家推荐一款对代码零入侵，同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具idea导出可执行jar包，在业内率先提出基于 JAVA 泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照 java-doc 标准编写注释idea导出可执行jar包，就能帮你生成一个简易明了的 Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。

这个项目的名字叫做 smart-doc，在 gitee 上已有 1.8K+的 start，项目代码仓库地址如下：

https://gitee.com/smart-doc-team/smart-doc

另外 smart-doc 可以和 Torna 搭配使用，使用 smart-doc 无侵入完成 Java 源代码分析和提取注释生成 API 文档，自动将文档推送到 Torna 企业级接口文档管理平台。

idea导出普通jar包_idea导出可执行jar包_idea导出单个文件jar包

1.smart-doc 特性:2.使用方法

smart-doc 可以很方便的和 Spring Boot 结合，你只需要在项目中添加如下的 Maven 插件即可：


    com.github.shalousun
    smart-doc-maven-plugin
    [最新版本]
    
        
        ./src/main/resources/smart-doc.json
        
        测试
        
        
            
            com.alibaba:fastjson
        
        
        
        
            
            
            com.alibaba:fastjson
        
    
    
        
            
            compile
            
                
                html

3.配置项

在项目中添加创建一个smart-doc.json配置文件，插件读取这个配置来生成项目的文档，这个配置内容实际上就是以前采用单元测试编写的ApiConfig转成 json 后的结果，因此关于配置项说明可以参考原来单元测试的配置。

最小配置单元：

{
   "outPath": "D://md2" //指定文档的输出路径,相对路径时请用./开头，eg:./src/main/resources/static/doc
}

如果你想把 html 文档也打包到应用中一起访问，则建议你配置路径为：src/main/resources/static/doc

仅仅需要上面一行配置就能启动 smart-doc-maven-plugin 插件，详细配置说明可以参考官方文档。

添加好插件和配置文件后可以直接运行 Maven 命令生成文档。

//生成html
mvn -Dfile.encoding=UTF-8 smart-doc:html
//生成markdown
mvn -Dfile.encoding=UTF-8 smart-doc:markdown
//生成adoc
mvn -Dfile.encoding=UTF-8 smart-doc:adoc

当然如果嫌手动输入命令比较麻烦，还可以使用 IDEA 的界面进行操作。

idea导出普通jar包_idea导出单个文件jar包_idea导出可执行jar包