smart-doc 1.8.2 发布,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. 修改gitee #I19IYW 。
2. 修改文档模板中的title设置错误。
3. 修改gitee #I191EO
4. 支持@Validated 分组
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,推荐使用最新版本的插件。
升级建议
本次主要是新增了分组验证支持,修复一些bug,需要相关功能的请升级。
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
相关文档
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
揭秘 vivo 如何打造千万级 DAU 活动中台 - 启航篇
本文首发于 vivo互联网技术 微信公众号 链接: https://mp.weixin.qq.com/s/Ka1pjJKuFwuVL8B-t7CwuA 作者:悟空中台研发团队 一、缘起 - 什么是悟空活动中台? 随着 vivo 互联网用户量级不断增加,应用商店、官网商城、 游戏中心和浏览器等 vivo 官方产品相继进入存量用户运营时代。在这种大背景下,营销活动日益增多,传统活动开发模式已经不能满足井喷式且多样化的需求,项目开发和产品运营过程中遇到种种困难: 1. 浏览器团队开发的活动组件, 商城活动项目能否拿来复用? 2. 游戏中心团队开发的 H5 页面,会员活动项目能否拿来复用? 3. H5 项目发布周期较长,修改文案需要重新上线,能否把活动运营效率最大化? 4. 轻 H5 业务能否节省相应配比的服务端和测试人力? 5.各 BU 业务不同,活动后台系统过多,研发效率和运营效率低下,导致数据孤岛现象严重。 6.研发轮子过多,问题场景没有标准的解决方案,营销活动常见问题没有官方团队进行统一收集沉淀。 7.非业务 H5 需求,如招聘、节日、活动报名等,需使用外部的建站产品且数据安全风险高。...
- 下一篇
Kooteam 0.9.2 发布,新一代轻量级团队协作系统
Kooteam 是一款轻量级的在线团队协作工具,提供各类文档工具、在线思维导图、在线流程图、项目管理、任务分发等工具,并接入了企业微信,钉钉开放平台,使用便捷高效。 在线地址:https://www.kooteam.com 上周一发布了最新一版,收到20多位同学的细致反馈,这次主要做bug修复,更新内容如下,欢迎大家使用。 更新记录 ## 修改记录 + 文档自动保存优化,增加防抖支持,刷新,关闭窗口时都能自动保存 + 修复特定情况下,应用启用失败异常 + 优化文档模样式,修复文档查看权限异常 + 修复第三方账号配置异常 + 修复文档语法高亮不显示异常 + 修复文档表格的单元不能缩放异常 + 文档上传图片失败异常 + 知识库删除异常 + 周报/日报邮件发送失败异常 + 任务责任人转交失败异常 ## 新增功能 + 新增Excel文档支持 + 任务增加归档支持 ## 已知异常 + 知识库模糊搜索 安装教程 https://www.kooteam.com/view.html?id=5e5893b9c687557cc87e38c3 升级方法: kooteam 安装目录下,执行 ./st...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Red5直播服务器,属于Java语言的直播服务器
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- Docker安装Oracle12C,快速搭建Oracle学习环境
- CentOS6,CentOS7官方镜像安装Oracle11G
- Jdk安装(Linux,MacOS,Windows),包含三大操作系统的最全安装
- CentOS关闭SELinux安全模块
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- Windows10,CentOS7,CentOS8安装MongoDB4.0.16
- Hadoop3单机部署,实现最简伪集群