smart-doc 1.7.8 发布,Java 零注解文档生成工具
smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档,当然还支持生成直接导入Postman的接口json文档。
如果你已经厌倦了 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、Postman json。
- 轻易实现在 Spring Boot 服务上在线查看静态 HTML5 api 文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
- 支持导出错误码和定义在代码中的各种枚举字典到接口文档。
Smart-doc vs Swagger
- smart-doc 不是对 Swagger 造轮子,这是一款用完全不同的理念重新开发的 restful api 接口文档生成工具。
- smart-doc 比 swagger 集成更简单,可以自由生成多种格式的 api 文档。
- smart-doc 完全不需要在侵入到业务代码中写任何注解,复杂嵌套对象自动推导出定义字段结构。
- smart-doc 代码量很少,如果不能满足你的需求完全可以自己修改源码定制(当前有数十家企业基于smart-doc强大的源码分析能力做二次修改内部使用)。
更新内容
- 修改Spring Controller使用非Spring Web注解时生成的响应示例出错的bug。
- 修改使用mybatis-plus实体继承Model对象时将log字段输出到文档的问题。
- html文档添加项目名称显示。
- 修改github #4 泛型中Void类型解析死循环。
- 修改github #5 简单枚举参数解析空指针异常。
- 重要新功能:Smart-doc支持生成Postman json接口测试数据,一键导入Postman即可测试接口。
DEMO
使用 demo 只有smart-doc能够自己分析出完善文档的demo
相关文档
- 关于 java web restful api 文档的重新探索
- smart-doc 功能使用介绍
- 项目官方 wiki (完善的文档和使用介绍)
用户评价
部分使用者对 smart-doc 的评价
- 最强大的 doc 组件,强制要求了规范,也不会污染代码,欣喜之情溢于言表!
- smartdoc 从注释入手,即规范强化了文档的编写又能提供源码文档之外的 api 功能,真的对得起 smart 的称谓。
开源贡献者招揽:
Smart-doc完全由个人开发者主导,随着Smart-doc不断的被很多企业所采用,维护工作变得越来越多,因此这里非常希望想贡献的开发者加入,
更多人一起把Smart-doc做成更好用的Java Restful Api文档生成工具。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
Kube-OVN v0.9.1 稳定性提升
该版本主要修复0.9.0 版本中反馈的问题,代码会维护两个分支,release分支主要是 bugfix,发布周期会稍微频繁一些,master上会有bugfix和新的功能,想试验新功能可以用 master分支。 问题修复 1. 当子网所有 IP 都被分配,再次分配 IP 会导致 panic 2. kube-ovn-cniserver 挂载 /var/run/netns 目录,避免 kind 集群出现的目录问题 3. 正确处理 svc 中 targetPort 为字符串的情况 4. start-ovs.sh 脚本中的错误 5. 删除节点时回收 ip/route 等资源 6. nbctl 增加超时控制,避免无限阻塞的情况 7. 当子网中还有 IP 使用时,阻塞子网删除操作
- 下一篇
Taskover 个人任务管理系统 v2.0.0 发布,支持拖拽排序
本次更新全面支持Plan、List、Task拖拽排序(时隔两年,平均半年动一次刀 :D) 主要更新功能点 支持Plan、List、Task拖拽排序 支持修改Plan、List 修复中文回车提交功能问题 界面以及其他小Bug的更新... 功能预览 简易方便的任务分类(Plan) 简单易用的任务分组(List) 简单高效的任务管理(Task)
相关文章
文章评论
共有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请求并返回结果
推荐阅读
最新文章
- CentOS关闭SELinux安全模块
- Hadoop3单机部署,实现最简伪集群
- CentOS6,7,8上安装Nginx,支持https2.0的开启
- SpringBoot2全家桶,快速入门学习开发网站教程
- SpringBoot2更换Tomcat为Jetty,小型站点的福音
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- MySQL8.0.19开启GTID主从同步CentOS8
- Docker快速安装Oracle11G,搭建oracle11g学习环境
- SpringBoot2整合Redis,开启缓存,提高访问速度