SMART-DOC使用总结

​​​​​​

1.Smart-doc是什么？

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

2.Smart-doc优点

零注解、零学习成本、只需要写标准JAVA注释。

基于源代码接口定义自动推导，强大的返回结构推导。

支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。

支持Callable、Future、CompletableFuture等异步接口返回的推导。

支持JavaBean上的JSR303参数校验规范，包括分组验证。

对JSON请求参数的接口能够自动生成模拟JSON参数。

对一些常用字段定义能够生成有效的模拟值。

支持生成JSON返回值示例。

支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。

支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 开放文档数据，可自由实现接入文档管理系统。

支持导出错误码和定义在代码中的各种字典码到接口文档。

支持Maven、Gradle插件式轻松集成。

支持Apache Dubbo RPC接口文档生成。

debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

3.Smart-doc缺点

界面支持不完善，没有发送请求的页面，无法满足小团队自测。

一些使用场景支持不完善，存在一些bug。

暂不支持其他框架文档的生成，如：dubbo等。

开源团队人员少，功能实现慢。

4.Smart-doc怎么用

Pom添加组件：

添加配置文件smart-doc.json：

点击执行：

运行结果：

效果展示：

5.Smart-doc总结

首先，Smart-doc使用门槛低，没有代码侵入，配置整合简单方便，比较轻量级。

结合实测，Smart-doc对接口注释规范要求较。

Smart-doc运行时占用资源比较多，性能不好。

Smart-doc接口文档界面比较丑。

Smart-doc总体来说除了代码侵入少外，比起主流swagger比较小众，相关资源也不多，建议酌情使用。