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比较小众，相关资源也不多，建议酌情使用。

SMART-DOC使用总结相关推荐

Smart—doc配置
Smart-doc配置依赖 <dependency><groupId>com.github.shalousun</groupId><artifactId&g ...
我的软件推广成功之路 [转]
我的软件推广成功之路本人与大家一样,原来只是一个普通的程序员,靠给软件公司打工谋生.后来感觉这样长期干下去没有什么前途,虽然现在年轻还可以加班加点靠拼身体吃饭,以后年纪大了怎么办?听说很多人自己单干 ...
smart-doc初体验-springboot生成自动文档
smart-doc初体验一.为什么要引入smart-doc? 二.对比swagger 三.使用四.讨论 1.设计先行模式 2.代码先行五.体验六.附录 1.完整的配置项: 2.官方地址: 一. ...
猿创征文｜小而巧的API文档生成工具之smart-doc
文章目录 smart-doc介绍 smart-doc特性 smart-doc的最佳搭档谁在使用smart-doc smart-doc的优缺点 smart-doc和swagger区别比较 smart- ...
我的软件推广成功之路
本人与大家一样,原来只是一个普通的程序员,靠给软件公司打工谋生.后来感觉这样长期干下去没有什么前途,虽然现在年轻还可以加班加点靠拼身体吃饭,以后年纪大了怎么办?听说很多人自己单干每年靠共享软件都可以赚 ...
PDF与doc格式互换
PDF与doc格式互换在当今的计算机世界里,使用率最高的两种文档方式分别是Microsoft Word的Doc格式和Adobe Acrobat的Pdf格式文件.由于微软的***,我们现在所使用的绝大 ...
android流量监控步骤_Android流量网络监控设计(超级实用版).doc
Android流量网络监控设计(超级实用版).doc 摘要伴随着Android智能移动设备的普及,其对网络系统和流量监控的要求越来越高,因而,让用户有能力实现对移动设备网络流量的实时监控和显示,同 ...
linux嵌入式智能家居环境监测系统的设计,智能家居环境监测系统.doc
智能家居环境监测系统.doc 智能家居环境监测系统近些年来,智能家居系统的使用功能愈加健全.本文之中在充分了解嵌入式系统平台的具体构建的前提下,以智能家居系统当前的功能要求为主要方向,以该平台的硬件 ...
odoo学习必看-提问的智慧《How To Ask Questions The Smart Way》
odoo学习必看-提问的智慧<How To Ask Questions The Smart Way> 人必自助而后人助之,而后天助之.出自<周易·系辞上> 访问原文感觉这篇文 ...
产品需求分析与市场分析方法汇总（SWOT+PDCA+波士顿矩阵BCG+5W2H分析法+STAR关键事件分析法+目标管理SMART+时间管理紧急重要矩阵+WBS任务分解法）
产品需求分析与市场分析方法汇总(SWOT+PDCA+波士顿矩阵BCG+5W2H分析法+STAR关键事件分析法+目标管理SMART+时间管理紧急重要矩阵+WBS任务分解法) 产品需求分析与市场分析方法汇 ...

SMART-DOC使用总结

SMART-DOC使用总结相关推荐

最新文章

热门文章