smart-doc 1.7.5 发布,Java 零注解文档生成工具
smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!喜欢smart-doc的用户也不要忘记给项目star,你们的支持是smart-doc持续推进的动力。
功能特性
- 零注解、零学习成本、只需要写标准java注释。
- 基于源代码接口定义自动推导,强大的返回结构推导。
- 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
- 支持Callable,Future,CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范。
- 对json请求参数的接口能够自动生成模拟json参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成json返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档:Markdown、HTML5、Asciidoctor。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
- 支持导出错误码和定义在代码中的各种枚举字典到接口文档。
Smart-doc vs Swagger
- smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解,复杂嵌套对象自动推导出定义字段结构。
- smart-doc代码量很少,如果不能满足你的需求完全可以自己修改源码。
更新内容
- 优化文档中错误列表的标题,可根据语言环境变化显示中文或因为。
- 解决项目外jar中内部类生成文档错误的bug。
- 支持环形依赖分析。
- 修改使用SpringMvc或者SpringBoot上传时接口的Content-Type显示错误。
- 支持设置项目作为markdown的一级标题。
- 修改方法注释相同引起的html链接跳转错误。
- 添加生成AllInOne的覆盖配置项,默认自动加版本号不覆盖。
- 新增枚举字典导出到文档的功能。
升级建议
这次是根据用户提交的issues添加了一些功能和做了大量细节优化,为了更好的体验,无论是新老用户请升级到最新版本(最近国外仓库更新有点慢,如果不能下载的稍安勿躁)。
DEMO
使用demo轻松玩转接口文档生成
相关文档
用户评价
部分使用者对smart-doc的评价
- 最强大的doc组件,强制要求了规范,也不会污染代码,欣喜之情溢于言表!
- smartdoc从注释入手,即规范强化了文档的编写又能提供源码文档之外的api功能,真的对得起smart的称谓。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
goMontioringDdl 1.0.1 更新,钉钉发送消息添加优化建议
v1.0.1版本更新 1、更新钉钉消息提示的bug 2、添加优化建议 3、调用tidb的类库对ddl操作的sql进行启发式的建议 效果图
- 下一篇
xplay 1.0.1 发布,专为树莓派设计的多媒体播放器
xplay v1.0.1.v20191105发布,在发布之前已经在内部测试很久,提交百次修改,力求稳定。 现在的 xplay 可以在 Raspberry Pi 中以低内存占用稳定运行,即使在 Raspberry Zero 中。 在功能上尽可能的丰富,(视频、音频、流媒体、图片、摄像头、动画、文本、滚动字幕、二维码) ... xplay 不是 omxplayer ,xplay 可以通过 api 无缝控制 ....https://gitee.com/nljb/xplay 支持硬件 硬件 分辨率 FPS 测试 Raspberry Pi Zero 1080p/v720p 30 已测试 Raspberry Pi 3A+ 1080p/v720p 30 已测试 Raspberry Pi 3B+ 1080p/v720p 30 已测试 Raspberry Pi 2B 1080p/v720p 30 未测试 Raspberry Pi 3B 1080p/v720p 30 未测试 Raspberry Pi 4B GL1 Mode 无 待适配 理论上支持所有树莓派,但是经过测试的树莓派只有上面几款 支持系统 系统...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS8安装Docker,最新的服务器搭配容器使用
- CentOS7编译安装Cmake3.16.3,解决mysql等软件编译问题
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- Jdk安装(Linux,MacOS,Windows),包含三大操作系统的最全安装
- CentOS7,8上快速安装Gitea,搭建Git服务器
- SpringBoot2全家桶,快速入门学习开发网站教程
- Docker安装Oracle12C,快速搭建Oracle学习环境
- CentOS8编译安装MySQL8.0.19
- MySQL8.0.19开启GTID主从同步CentOS8
- CentOS7安装Docker,走上虚拟化容器引擎之路