smart-doc 1.8.0 发布,Java 零注解文档生成工具
smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman json一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,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 json。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
Smart-doc vs Swagger
- smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解。
更新内容
1. 响应用户需求,对spring的表单参数绑定做了全面的支持,smart-doc不再是仅仅支持json参数。
2. 合并fork分支的github book html5模板,新增搜索和锚点。
3. 新增自定义@mock tag用于指定生成文档时的默认字段值,@param 的参数注释增加mock值的解析功能(@param name 姓名|张三),
此项改进可以满足用户直接使用smart-doc生成交付给第三方公司的对接文档。
4. smart-doc-maven-plugin插件增强对maven标准项目的支持(插件仍然存在一些问题,当前未找到解决办法)。
5. 对生成的postman json数据做了全面的增强,无论是json还是表单参数,导出的postman json可以一键导入postman自动完成参数列表回填。
6. 优化对实体类中枚举字段的支持。
7. 增加对实体中静态常量常量字段的过滤。
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,目前该插件只做试用。
升级建议
本次主要是对表单参数和postman数据导出做了增强。也修改了一起bug和部分源码做了重构,建议用户升级到最新。
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
相关文档
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
wechat-app-mall 7.4.3 发布,微信小程序商城
微信小程序商城 wechat-app-mall 已经升级至 version 7.4.3,具体详情请查看 码云项目主页更新 本次更新功能如下: fixed: 优惠买单功能,仅使用余额买单的情况下,无法买单; 分类页面,分类个数或者商品数量不满一页时候导致样式显示异常; 其他的一些 bug 修复; improve: 基于本地 storage 的购物车功能调整为通过购物车全系 api 接口实现,简化购物车开发,同时可实现多端购物车(微信小程序、头条/抖音小程序、网页、app 等)同步; 底部 ICON 图标更换,整体效果更趋向扁平化风格; 整体 UI 调整美化; 首页搜索功能优化,搜索结果以单独列表页展示; 小程序模板消息调整为订阅消息; new: 新增商品列表页面 内页增加快速悬浮导航
- 下一篇
如何在阿里云ECS服务器中挂载文件系统NAS?
我们创建了文件系统NAS后,会给它添加挂载点和存储包。现在选择一个云服务器ECS来尝试对它进行访问。 在文件系统列表中,点击管理,进入详情页。 详情页中有文件系统的基本信息、存储包信息和挂载点信息,复制以下挂载点地址,以备后面使用。 在屏幕左上角的控制台→产品与服务中选择云计算基础服务→弹性计算→云服务器ECS。 选择华南1区,创建一台CentOS7.3的云服务器。点击远程连接。 输入密码,点击确定。 首先安装依赖库,在客户端中输入sudo yum install nfs-utils。 安装完成后,使用NFS4的方式进行挂载,输入上述在文件系统详情中复制的挂载命令。 sudo mount -t nfs -o vers=4,minorversion=0,noresvport *:/ /mnt ://mnt表示将根目录挂载到本地的mnt目录下。 显示以上信息,表示已经挂载成功了。 更多信息见:文件存储
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
-
Docker使用Oracle官方镜像安装(12C,18C,19C)
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- CentOS8编译安装MySQL8.0.19
- Docker快速安装Oracle11G,搭建oracle11g学习环境
- SpringBoot2配置默认Tomcat设置,开启更多高级功能
- MySQL8.0.19开启GTID主从同步CentOS8
- CentOS7,8上快速安装Gitea,搭建Git服务器
- Jdk安装(Linux,MacOS,Windows),包含三大操作系统的最全安装
- SpringBoot2编写第一个Controller,响应你的http请求并返回结果
推荐阅读
最新文章
- CentOS7设置SWAP分区,小内存服务器的救世主
- 设置Eclipse缩进为4个空格,增强代码规范
- CentOS8安装MyCat,轻松搞定数据库的读写分离、垂直分库、水平分库
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- SpringBoot2编写第一个Controller,响应你的http请求并返回结果
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- CentOS6,CentOS7官方镜像安装Oracle11G
- Hadoop3单机部署,实现最简伪集群
- CentOS7编译安装Cmake3.16.3,解决mysql等软件编译问题
- CentOS7安装Docker,走上虚拟化容器引擎之路