smart-doc 1.7.6 发布,Java 零注解文档生成工具

上官胡闹
 上官胡闹
发布于 2019年11月14日
收藏 33

本周日,来 OSC·年终盛典收割技术干货,get新技能!!>>>

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 完全不需要在侵入到业务代码中写任何注解,复杂嵌套对象自动推导出定义字段结构。
  • smart-doc 代码量很少,如果不能满足你的需求完全可以自己修改源码。

更新内容

  •  fix #I14PT5 header 重复渲染到文档
  •  fix #I14MV7 不设置 dataDictionaries 出现空指针错误
  •  增加请求参数枚举字段解析(试用功能)

升级建议

     这个一个跟进用户提交的 issues 修复的版本,建议升级到最新版本避免一些 bug

DEMO

使用 demo 轻松玩转接口文档生成

相关文档

用户评价

部分使用者对 smart-doc 的评价

  1. 最强大的 doc 组件,强制要求了规范,也不会污染代码,欣喜之情溢于言表!
  2. smartdoc 从注释入手,即规范强化了文档的编写又能提供源码文档之外的 api 功能,真的对得起 smart 的称谓。
本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:文章转载自 OSCHINA 社区 [http://www.oschina.net]
本文标题:smart-doc 1.7.6 发布,Java 零注解文档生成工具
加载中

精彩评论

上官胡闹
上官胡闹
不要看相关链接,我发布的时候修改了好像没生效,项目源码地址:
https://gitee.com/sunyurepository/smart-doc.git
上官胡闹
上官胡闹
smart-doc目前每周都会去解决用户提出的问题,所以一直在更新

最新评论(5

O
OSC_hAgcQq
这个能支持集成测试吗?
上官胡闹
上官胡闹
现在没有精力搞集成测试这些功能,只能借希望于愿意参与开源的其他人了
z
zhangleijie
这个确实好用
上官胡闹
上官胡闹
不要看相关链接,我发布的时候修改了好像没生效,项目源码地址:
https://gitee.com/sunyurepository/smart-doc.git
上官胡闹
上官胡闹
smart-doc目前每周都会去解决用户提出的问题,所以一直在更新
返回顶部
顶部