smart-doc 1.9.0 发布,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. 修改dubbo html依赖部分错乱问题。
2. 新增自定义输出文件名称的配置。
3. 添加请求和响应示例的开关配置项。
4. 修改使用JSR303参数校验时,默认分组验证被忽略问题。
5. 修改jackson JsonIgnore注解在参数对象中不生效的问题。
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,推荐使用最新版本的插件。当然官方的gradle插件已经开发完毕,
gradle插件目前在测试阶段,使用gradle的用户可以先拉取gradle插件源码自行编译使用等待后续测试完发布。
升级建议
本次升级合并了两个用户提交的pr,并修改了一些下bug。smart-doc的升级目前几乎属于平滑性的升级。我们一直到修复bug,因此建议用户升级
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
Diboot 2.1.1发布,新增前端代码生成,CRUD 等不再手写
Diboot 2.1.1版本已于近日发布,带来若干项优化,增加对关联表字段查询条件的支持,Devtools新增前端代码生成等支持,CRUD、导入、导出等不再手写,CRUD的表单类型多达13项,涵盖了常规需求的表单范围,此次更新也对文档结构与内容进行了相关调整,重新录制了上手视频,整理出了playground包等。 一、快速体验 上手视频 playgroud弹药包 官网地址 Gitee Github 二、前端设计器展示 前端生成表选择 前端设计器 前端设计器功能示例 三、案例展示 登录页面示例 列表页示例 表单示例 详情示例 数据上传示例 四、新特性 diboot-core 🔨增强@BindQuery注解,支持跨表字段的动态Join查询 🎉新增@BindFieldList注解,用于绑定某个字段的集合 🎉新增@DataAccessCheckpoint注解,以支持数据权限相关处理 🎉新增@Accept(name)注解,支持非同名字段间的值拷贝 🎉新增:V.equals()对Map类型的比较 🍻优化BindQuery注解,支持BETWEEN绑定List类型对象 🍻优化: ...
- 下一篇
RuoYi-Vue 3.0 发布,进行模块拆分
若依前后端分离版本v3.0已发布,更新日志: 单应用调整为多模块项目 升级element-ui版本到2.13.2 删除babel,提高编译速度。 新增菜单默认主类目 编码文件名修改为uuid方式 定时任务cron表达式验证 角色权限修改时已有权限未自动勾选异常修复 防止切换权限用户后登录出现404 Excel支持sort导出排序 创建用户不允许选择超级管理员角色 修复代码生成导入表结构出现异常页面不提醒问题 修复代码生成点击多次表修改数据不变化的问题 修复头像上传成功二次打开无法改变裁剪框大小和位置问题 修复布局为small者mini用户表单显示错位问题 修复热部署导致的强换异常问题 修改用户管理复选框宽度,防止部分浏览器出现省略号 IpUtils工具,清除Xss特殊字符,防止Xff注入攻击 生成domain 如果是浮点型 统一用BigDecimal 定时任务调整label-width,防止部署出现错位 调整表头固定列默认样式 代码生成模板调整,字段为String并且必填则加空串条件 代码生成字典Integer/Long使用parseInt 修复dict_sort不可update为0的...
相关文章
文章评论
共有0条评论来说两句吧...