smart-doc 1.8.3 发布,Java 零注解文档生成工具
smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,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、Postman collection。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
Smart-doc vs Swagger
- smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解。
更新内容
1. 增加从接口方法getter或者setter方法中读取注释。
2. 修改smart-doc默认编码为utf-8,解决生成文档乱码问题。
3. 增强对代码中@author tag的支持,当方法没有@author tag支持多作者。
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,推荐使用最新版本的插件。
升级建议
最近的版本重写了大多数功能,近期有多数用户反馈生成文档存在乱码,因此我们做了紧急版本发布解决乱码功能
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
相关文档
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
若依后台管理系统 4.2 发布,新增多项功能
若依管理系统 v4.2已发布,更新日志: 用户管理添加分配角色页面 定时任务添加调度日志按钮 新增是否开启用户注册功能 新增页面滚动显示返回顶部按钮 定时任务&角色管理添加更多操作按钮 iframe框架页会话过期弹出超时提示 移动端登录不显示左侧菜单 侧边栏添加一套深蓝色主题 首页logo固定,不随菜单滚动 任务分组字典翻译(调度日志详细) 字典管理添加缓存读取 字典数据列表标签显示样式 参数管理支持缓存操作 日期控件清空结束时间设置开始默认值为2099-12-31 表格树添加获取数据后响应回调处理 批量替换表前缀调整 支持表格导入模板的弹窗表单加入其它输入控件 表单重置刷新表格树 新增支持导出数据字段排序 新增表格参数(是否单选checkbox) druid未授权不允许访问 表格树父节点兼容0,'0','',null 表单必填的项添加星号 修复select2不显示校验错误信息 添加自定义HTML过滤器 修复多数据源下enabled=false导致读取不到bean导致异常问题 修复翻页记住选择项数据问题 用户邮箱长度限制20 修改错误页面返回主页出现嵌套问题 表格浮动提示单双引...
- 下一篇
Smart Retry 1.3.3 发布
Smart Retry 主要是用来进行方法重试的。和Guava Retry、Spring Retry相比,Smart Retry最大的特点是异步重试,支持持久化,系统重启之后可以继续重试。 项目特点 方法重试持久化,系统重启之后可以继续重试 异步重试(不支持同步重试) 支持接口实现和声明式方式 大量的扩展点 提供重试Job可视化管理 适用场景 方法重试需要持久化,系统重启、宕机恢复之后继续重试,直到重试成功 分布式事务最终一致性 使用示例 <dependency> <groupId>com.github.hadoop002.smartretry</groupId> <artifactId>retry-spring4</artifactId> <version>1.3.3</version> </dependency> @RetryFunction(identity = "order.payment") public void payOrderAndUpdateStatus...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Docker安装Oracle12C,快速搭建Oracle学习环境
- 设置Eclipse缩进为4个空格,增强代码规范
- Docker快速安装Oracle11G,搭建oracle11g学习环境
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- SpringBoot2整合Redis,开启缓存,提高访问速度
- Hadoop3单机部署,实现最简伪集群
- Windows10,CentOS7,CentOS8安装Nodejs环境
- Windows10,CentOS7,CentOS8安装MongoDB4.0.16
- CentOS关闭SELinux安全模块
- Docker使用Oracle官方镜像安装(12C,18C,19C)