介绍
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。
你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。
目前使用者
-
科大讯飞
-
小米
-
一加
-
顺丰
特点
-
零注解、零学习成本、只需要写标准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标记下载方法)测试。
Java进阶视频资源
效果示例
1.1 接口文档效果图
1.2 html全局效果
更多了解，开源地址：https://gitee.com/smart-doc-team
投 稿 通 道
#
让你的博客被更多人看到
如果你在 CSDN、博客园、掘金等平台有写技术博客的习惯，想让自己的原创博客被更多人看到，可以来 Java后端 投稿。
???? 稿件基本要求：
• 文章确系个人原创作品，如果在其他非公众号渠道有过发表也可以，只要是个人原创即可。
• 稿件建议以 markdown 格式撰写，文中配图以附件形式发送，要求图片清晰、语句通顺。
• 如果被采纳的原创稿件，我们将提供稿费以及个人影响力曝光，具体依据文章阅读量和质量结算稿费。
???? 投稿通道：
• 投稿请联系下方微信，备注：原创投稿
△长按添加 Java后端 小编
本文分享自微信公众号 - Java后端（web_resource）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。
相关文章
暂无评论...
致力于称为最好的程序员导航网站