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

上官胡闹
 上官胡闹
发布于 2019年09月22日
收藏 38

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写就能得到一个标准的markdown接口文档。如果你已经厌倦了swagger等文档工具的注解和强侵入污染,那请拥抱smart-doc吧!

功能特性

  • 零注解、零学习成本、易集成、只需要写标准java注释。
  • 基于源代码接口定义自动推导(唯一实现对象关联无限级自推导)。
  • 支持Spring MVC,Spring Boot。
  • 目前支持javabean上定义的部分fastjson和jackson注解。
  • 支持javabean上基于jsr303参数检验判断参数是否为必须。
  • 对json请求参数的接口能够自动生成模拟json参数。
  • 对一些常用字段定义能够生成有效的模拟值。
  • 支持生成json返回值示例。
  • 支持从项目外部加载源代码来生成字段注释。
  • 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。

更新内容

  •  升级smart-doc依赖的基础库。
  • 增加对普通的get请求参数拼装示例的生成。
  • 增加spring mvc占位符restful url请求示例生成。

升级建议

    目前软件功能不断迭代,smart-doc的原始用户强烈建议升级到最新版。

下一版升级预告

       目前smart-doc一些重要的功能已经完成开发,节后会发布下一个重大版本。下一次升级将意味着它将会为更多的开发者提供服务,

将会真正意义上成为众多java web开发者首选的api doc生成工具,也意味着留给swagger的时间不多了,需要的小伙伴请赶紧收藏好,。下一版功能预告(已进入测试阶段):

  •    新增Spring Boot Web Flux(controller书写方式)。
  •    新增Callable,Future,CompletableFuture等异步接口返回的推导支持。
  •    修改过去版本中smart-doc生成文档中的一些细节。
  •    重点:新增生成静态html书签式api文档的功能实现在线查看api文档(可先预览smart-doc提供demo中的html文档)

DEMO

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

相关文档

关于java web restful api文档的重新探索

smart-doc功能使用介绍

 

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:文章转载自 OSCHINA 社区 [http://www.oschina.net]
本文标题:smart-doc 1.6.4 发布,Java 零注解文档生成工具
加载中

精彩评论

noday
noday

最新评论(1

noday
noday
返回顶部
顶部