一款零注解侵入的 API 文档生成工具,你用过吗?
猿天地
共 1281字,需浏览 3分钟
· 2021-07-05
点击上方蓝色字体,选择“设为星标”
介绍
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标记下载方法)测试。
Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能,并且比 swagger ui 更简洁大方,也更符合国内开发者的诉求。
当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。另外,欢迎关注公众号Java笔记虾,后台回复“后端面试”,送你一份面试题宝典!
效果示例
1.1 接口文档效果图
![1.png](https://filescdn.proginn.com/233543fe67905a1bf5b8c7fb3080e1c2/5872e3ca31035b1c030d0162129ebd76.webp)
![1.png](https://filescdn.proginn.com/9b0b8093b06d799c1c6d5d3c9ba51ce1/e444dbf44017f1830205c1726709237d.webp)
1.2 html全局效果
![example.png](https://filescdn.proginn.com/8420179de34ef6b58ded02e9c95f8cc7/63752e6e1c13311516e1004aee25e922.webp)
更多了解,开源地址:https://gitee.com/smart-doc-team
后台回复 学习资料 领取学习视频
如有收获,点个在看,诚挚感谢
评论
岚角山街道岚角山社区
2005年,岚角山社区被命名为第二批湖南省民主法治示范村(社区)。岚角山社区是湖南省永州市冷水滩区岚角山街道下辖的社区,城乡分类代码为111,为主城区。区划代码为431103009007,居民身份证号
岚角山街道岚角山社区
0
岚角山街道
地名由来:镇沿用驻地岚角山自然地名。岚角山系镇内的一座小山,地势低平,山上多石常有雾,故而得名。李达故居李达故居岚角山街道辖石木冲、长塘角、巴洲等30个建制村和楚江圩、岚角山2个社区,人口2.85万人
岚角山街道
0
岚角山街道春光村
2021年4月,春光村被确定为湖南省乡村振兴重点帮扶村。春光村是湖南省永州市冷水滩区岚角山街道下辖的行政村,城乡分类代码为220,为村庄。区划代码为431103009215,居民身份证号码前6位为43
岚角山街道春光村
0