smart-doc 1.8.8 发布,Java 零注解文档生成工具
smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态html文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!
功能特性
- 零注解、零学习成本、只需要写标准java注释。
- 基于源代码接口定义自动推导,强大的返回结构推导。
- 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
- 支持Callable,Future,CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范,支持分组验证。
- 对json请求参数的接口能够自动生成模拟json参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成json返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman collection。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
- 插件式快速集成(支持maven和gradle插件)。
- 支持apache dubbo rpc文档生成。
Smart-doc vs Swagger
- smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解,插件化集成到项目。
- smart-doc提供了许多swagger没有功能,例如:字典码、业务错误码导出到文档,dubbo rpc接口文档生成。
更新内容
1. 修改忽略对LinkedHashMap的解析,gitee #I1JI5W。
2. 修改接口或和实现类合并分析是字段重复问题,gitee #I1JHMW。
3. 优化接口方法字段不能获取docletTag的问题。
4. 优化枚举参数展示,支持自定义控制显示。
5. 添加Feign的支持。
6. 优化递归执行,对外提供递归次数限制。
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,推荐使用最新版本的插件。当然官方的gradle插件已经开发完毕,
gradle插件目前在测试阶段,使用gradle的用户可以先拉取gradle插件源码自行编译使用等待后续测试完发布。
升级建议
本次修改用户提出的很多bug,建议升级到新版本
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
MeEdu v3.1 版本上线,在线教育点播系统
新增 added:积分功能(看视频,完成课程,注册,支付订单,邀请5个送积分场景) added:积分api接口 added: 积分变动站内消息通知 added: 用户隐私政策 added:课程附件 优化 优化:api限流由60/分钟改为120/分钟 优化:课程列表的课节数量改为订阅数量 优化:手动支付 优化:H5课程详情封面改为100%宽度 优化:code style 优化:H5暂无数据组件大小调整 优化:前端静态资源版本号 优化:H5的分页组件 修复 fixed: 视频下单api接口返回的错误信息 fixed: 后台用户编辑删除vip报错 fixed: 我的邀请码接口返回奖励字段 fixed: 关于我们界面的图片可能溢出问题 fixed: 部分h5页面引入了错误的暂无数据组件 Github:https://github.com/Qsnh/meedu Gitee:https://gitee.com/myteng/MeEdu 官网:https://meedu.vip MeEdu 是基于 Laravel 开发的个人在线教育系统。MeEdu诞生的背景:随着知识付费领域的兴起,尤其是知识付费领...
- 下一篇
screw 1.1.0 正式发布啦,简洁好用的数据库表结构文档生成工具
Hi,亲爱的广大开发者朋友们,很高兴,screw 1.1.0 正式发布啦, 在企业级开发中、我们经常会有编写数据库表结构文档的时间付出,繁琐麻烦且容易出错,不过有了screw,你只需要在项目中进行集成,配置即可,轻松生成数据库表结构文档,screw 支持多种主流数据库,且设计良好,轻量级且方便扩展,支持自定义模板,嘿嘿,真香。 功能 数据库 支持MySQL数据库 支持MariaDB数据库 支持Oracle数据库 支持TIDB数据库 支持SQL Server数据库 支持PostgreSQL数据库 生成引擎 支持Freemark模板引擎 支持Velocity模板引擎 文档格式 支持HTML格式文档生成 支持自定义模板文件 相关链接 详细介绍:点击查看 快速上手:点击查看
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- CentOS8安装Docker,最新的服务器搭配容器使用
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- 设置Eclipse缩进为4个空格,增强代码规范
- Red5直播服务器,属于Java语言的直播服务器
- SpringBoot2整合Redis,开启缓存,提高访问速度
- SpringBoot2配置默认Tomcat设置,开启更多高级功能
- SpringBoot2更换Tomcat为Jetty,小型站点的福音
- CentOS7,8上快速安装Gitea,搭建Git服务器
- CentOS7安装Docker,走上虚拟化容器引擎之路