方式一 插件方式 springboot 启动类 运行生成接口文档 1.pom文件 导入插件 2.resource目录下 smart-doc.json 配置文件 方式二 jar包方式 1.pom 导入jar包 ...

工具开源地址 swagger2 : https://swagger.io/ smart-doc： https://www.oschina.net/p/smart-doc 国产 两者的比较 swagger2 和 smart-doc 两个开源工具 都可以 使用jar包 生成 api 文档 ...

最近领导分了一个调研smart-doc的任务，可以扫描项目中Controller类，生成接口文档，省去了人工手写文档的工作，而且随时生成，便于维护；缺点就在于，要用这个第三方工具来限制规范代码，例如方法、实体、控制层的注解编写规范，增大项目负荷。 建议刚接触的朋友根据场景，慎重考虑。 生成 ...

第一步： 　　添加plugin插件， 第二步： 　　新建smart-doc.json配置文件 　　 第三步： 　　查看maven里面的plugins会出现smart-doc，会有生成接口文档的按钮。 　　 ...

传统swagger（之前在用）接口文档的缺点： 1、代码侵入性太强。 2、写着麻烦。需要写大量的注解，太麻烦！ smart-doc的优点： 1、不需要注解，无侵入性。 2、只需要写好注释即可，界面也比较美观。 3、对一些常用的电话、地址之类的模拟的数据跟真的一样（哈哈哈 ...

众所周知（真不是人云亦云） swagger强大吗？强大的。但是代码侵入性太强了！ japidocs ,没有代码入侵问题，也很好！ 但是有个bug！没有办法传入接口泛型对象。 ...

1,引入maven <dependency> <groupId>com.github.terran4j</groupId> <artifactId>terran4j-commons-api2doc</artifactId> ...

初衷 记得以前写接口，写完后会整理一份API接口文档，而文档的格式如果没有具体要求的话，最终展示的文档则完全决定于开发者的心情。也许多点，也许少点。甚至，接口总是需要适应新需求的，修改了，增加了，这份文档维护起来就很困难了。于是发现了swagger，自动生成文档的工具。 swagger介绍 ...