smart-doc 1.8.7 发布,Java 零注解文档生成对象

上官混闹
 上官混闹
发布于 2020年06月03日
收藏 32

精选30+云产品,助力企业轻松上云!>>>

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. 增长对java接口的分析,例如Jpa的分页Page类。
2. 加强对应用@RequestBody绑定参数办法的解析。
3. 增长将驼峰字段格局转化为下划线格局。
4. maven插件和gradle插件供给includes支撑,便利自行设备加载第三方库。
5. fix #32.
6. 增长文档接口根据接口标题排序功能。

重要发布内容

根据用户的反应,我们在smart-doc上增长了对dubbo rpc接口的扫描生成api文档,你不再消手写rpc接口的文档了。

maven插件

从smart-doc 1.7.9版本开端。我们供给了smart-doc的插件smart-doc-maven-plugin,推荐应用最新版本的插件。固然官方的gradle插件曾经开辟终了,

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

插件应用文档

升级建议

   本次发布主如果发布了更新的器械比较多插件,特别是初次发布多dubbo rpc的支撑

DEMO

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

有名用户

  • 科大年夜讯飞
  • 一加
  • 小米
本站文章除注明转载外,均为本站原创或编译。迎接任何情势的转载,但请务必注明出处,尊敬他人休息共创开源社区。
转载请注明:文章转载自 OSCHINA 社区 [http://aledoyoga.com]
本文标题:smart-doc 1.8.7 发布,Java 零注解文档生成对象
加载中
此消息有 8 条评论,请先登录后再检查。
前往顶部
顶部