smart-doc 1.7.6 发布,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 代码量很少,如果不能满足你的需求完全可以自己修改源码。
更新内容
- fix #I14PT5 header 重复渲染到文档
- fix #I14MV7 不设置 dataDictionaries 出现空指针错误
- 增加请求参数枚举字段解析(试用功能)
升级建议
这个一个跟进用户提交的 issues 修复的版本,建议升级到最新版本避免一些 bug
DEMO
使用 demo 轻松玩转接口文档生成
相关文档
用户评价
部分使用者对 smart-doc 的评价
- 最强大的 doc 组件,强制要求了规范,也不会污染代码,欣喜之情溢于言表!
- smartdoc 从注释入手,即规范强化了文档的编写又能提供源码文档之外的 api 功能,真的对得起 smart 的称谓。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
小说精品屋 v1.3.0 发布,小说阅读弹幕网站
小说精品屋-小说阅读弹幕网站 V1.3.0版本发布了,主要改进包括: 更新 增加多爬虫源的配置 关闭百度和微博的推送接口 Bug 修复 修复 txt 下载会跳转到源网站的问题 其他 bug 修复 介绍 小说精品屋是一个多平台(包括 web、安卓和小程序平台)、功能完善的小说弹幕网站,包含精品小说专区和轻小说专区。包括小说分类、小说搜索、小说排行、完本小说、小说评分、小说在线阅读、小说书架、阅读记录、小说下载、小说弹幕、小说自动爬取、小说内容自动分享到微博、邮件自动推广、链接自动推送到百度搜索引擎等功能。包含电脑端、移动端、微信小程序等多个平台,现已开源 web 端、安卓端、小程序端源码,大家可以用于学习或者商用。 软件架构 Springboot+Mybatis+Mysql+Ehcache+Thymeleaf+Layui 项目截图 电脑端(首页) 移动端(首页) 移动端(轻小说专区) 移动端(小说详情页) 移动端(目录页) 移动端(小说阅读页) 小程序 功能开发清单(包括待开发计划) 点击下载高清大图 后期架构演进 为了满足部分网站用户量大、并发量高的需求,将计划明年5月份之前上线Spr...
- 下一篇
Elasticsearch Rest Client bboss v5.9.2 发布
The best Elasticsearch HighlevelRest Client API-----bbossv5.9.2 发布。 bboss elasticsearch 是一套基 于query dsl 语法操作和访问分布式搜索引擎 elasticsearch 的 o/r mapping 高性能java开发库,底层基于 es restful api。 主要功能特色 ElasticSearch兼容性:1.x,2.x,5.x,6.x,7.x,+ JDK兼容性: jdk 1.7+ Spring boot兼容性:1.x,2.x ORM和DSL二者兼顾,类mybatis方式操作ElasticSearch, 支持SQL和JDBC 提供快速而高效的数据同步导入ES工具(支持DB到Elasticsearch,Elasticsearch到DB,MongoDB到Elastisearch数据同步,后续将支持更多的数据源) 提供按时间日期ES历史数据清理工具 APM开源产品pinpoint官方Elasticsearch bboss 客户端性能监控插件,插件地址: https://github.com/...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Windows10,CentOS7,CentOS8安装Nodejs环境
- Docker安装Oracle12C,快速搭建Oracle学习环境
- Windows10,CentOS7,CentOS8安装MongoDB4.0.16
- CentOS8编译安装MySQL8.0.19
- MySQL8.0.19开启GTID主从同步CentOS8
- CentOS8安装Docker,最新的服务器搭配容器使用
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- SpringBoot2整合Redis,开启缓存,提高访问速度
- CentOS7,8上快速安装Gitea,搭建Git服务器
- Docker使用Oracle官方镜像安装(12C,18C,19C)