smart-doc 1.7.2 发布,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完全不需要在侵入到业务代码中写任何注解。
更新内容
1. 优化注释换行\n\r问题,依赖common-util 1.8.7。 2. 修改gitee上bug #I135PG。 3. 添加@requestHeader注解的支持,文档自定将参数绑定到请求头列表中。 4. 增加javadoc apiNote tag的支持。 5. 解决扫描分析controller中private方法的问题。 6. 添加支持@RequestParam注解重写参数名和设置默认值的文档解析。 7. 新增对Spring ResponseEntity的解析。 8. 增加内部类结构解析。 9. 修改文档中显示的字段类型,float、double等由原来的number直接变成具体类型。
升级建议
这个版本相对之前的版本做了很多推导优化和功能更新,增加很多用户期待的书签式html格式Api文档,强烈建议升级到最新版本。
DEMO
使用demo轻松玩转接口文档生成
相关文档
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
JEIM 企业即时通讯全新升级【1.0.1】,沟通更高效!
JEIM1.0.1版本最新发布,本次增加内容: 增加对会话列表的操作: 置顶以及非置顶: 消息免打扰: 免打扰之后若该会话有新的消息,则不会有语音提示; 移除会话 JEIM是基于JEPaaS低代码快速开发平台(JEPaaS链接)而搭建,支持个性化的前端设计,快速解决办公途中的沟通协同问题、缩短企业内部沟通距离、提高企业工作效率。 【适用场景】 主要适用于企业内部沟通,企业内部管理通讯等企业办公场景。 【本次发布内容包括】 好友聊天 群组聊天 通讯录 pc端沟通界面 pc端讨论组沟通界面 手机端讨论组及通讯录 【相关链接】 JEIM详细介绍:点击查看详情 JEIM下载地址:点击下载 JEPaaS低代码快速开发平台详细介绍:点击查看详情 JEPaaS低代码快速开发平台下载地址:点击下载 JEPaaS低代码快速开发平台绿色版下载地址:点击下载
- 下一篇
TypeORM 0.2.20 发布,ts/js 的 orm ,用于浏览器、APP和 node
Bug修复 确保私有属性,克隆查询构建器(#4843)(ea17094),关闭#4842 aurora:将mysql查询修复程序应用于aurora(#4779)(ee61c51) 允许将EntitySchema传递给EntityRepository(#4884)(652a20e) 更好的时间戳比较(#4769)(0a13e6a) 使用复制时损坏的数据库选项,由#4753(#4826)(df5479b)引入的更改 在提取COLUMN_DEFAULT(#4783)(c30b485)之前检查MariaDB的版本 连接在Lambda环境中重用中断:(#4804)(7962036) FindOptionUtils导出(#4746)(4a62b1c),关闭#4745 加载aurora-data-api驱动程序(#4765)(fbb8947) postgres:postgres查询运行程序以创建实例化视图(#4877)(d744966) mongodb(#4702)(2f27581)的迁移顺序相反 mongodb Cursor.forEach类型(#4759)(fccbe3e) 松弛邀请URL(#4...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Linux系统CentOS6、CentOS7手动修改IP地址
- CentOS8安装MyCat,轻松搞定数据库的读写分离、垂直分库、水平分库
- Red5直播服务器,属于Java语言的直播服务器
- SpringBoot2初体验,简单认识spring boot2并且搭建基础工程
- SpringBoot2全家桶,快速入门学习开发网站教程
- CentOS8编译安装MySQL8.0.19
- CentOS7,CentOS8安装Elasticsearch6.8.6
- SpringBoot2整合Redis,开启缓存,提高访问速度
- CentOS6,CentOS7官方镜像安装Oracle11G
- Windows10,CentOS7,CentOS8安装Nodejs环境