smart-doc 1.9.0 发布,新增 Open Api 3.0+ 支持

来源: 投稿
作者: 上官胡闹
2020-08-24

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态html文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱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文档。
  • 开放文档数据,可自由实现接入文档管理系统。
  • 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
  • 插件式快速集成(支持maven和gradle插件)。
  • 支持apache dubbo rpc文档生成。

Smart-doc vs Swagger

  •  smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
  •  smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
  •  smart-doc完全不需要在侵入到业务代码中写任何注解,插件化集成到项目。
  • smart-doc提供了许多swagger没有 的功能,例如:字典码、业务错误码导出到文档,dubbo rpc接口文档生成。

更新内容

  1. 修改前面版本修改引发的普通jsr 303验证解析错误问题。
  2. 新增忽略请求参数对象的配置gitee #I1RBJO。
  3. 修改smart-doc的beetl配置避免和用户的业务中beetl配置冲突。
  4. 新增ApiDataBuilder中获取树形格式参数数据的接口#40。
  5. 新增对Open Api 3.0的支持。
  6. 修改字典表空时内部发生空指针的问题。
  7. 优化curl用例,增加请求头。

maven插件

从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,推荐使用最新版本的插件。当然官方的gradle插件已经开发完毕,

gradle插件目前在测试阶段,使用gradle的用户可以先拉取gradle插件源码自行编译使用等待后续测试完发布。

插件使用文档

升级建议

  本次主要是新增了Open Api 3.0 +的支持

DEMO

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

知名用户

  • 科大讯飞
  • 一加
  • 小米
展开阅读全文
13 收藏
分享
加载中
最新评论 (4)
美美哒,昨天看到,今天已经用上了
2020-08-29 22:45
0
回复
举报
我想问下这个跟apidoc的区别是什么?都是根据注释生成
2020-08-24 12:52
0
回复
举报
apidoc是支持多语言的,在使用时你需要按照他的规则写很多的注释,apidoc主要是提取它的规则注释来生成文档。smart-doc是java开发的,对java web支持很好。smart-doc做了很多接口定义源码,接口出参入参的智能分析。因此整个开发写注释的工作量很小。
2020-08-24 13:41
0
回复
举报
投递新闻的还没写完按错了先投上来了,本次发布的是1.9.2+的版本,新增了Open Api 3.0 +文档规范的支持也修改了若干bug.
2020-08-24 10:15
0
回复
举报
更多评论
4 评论
13 收藏
分享
返回顶部
顶部