转载

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

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完全不需要在侵入到业务代码中写任何注解。

更新内容

1. 优化注释换行/n/r问题,依赖common-util 1.8.7。
2. 修改gitee上bug #I135PG。
3. 添加@requestHeader注解的支持,文档自定将参数绑定到请求头列表中。
4. 增加javadoc apiNote tag的支持。
5. 解决扫描分析controller中private方法的问题。
6. 添加支持@RequestParam注解重写参数名和设置默认值的文档解析。
7. 新增对Spring ResponseEntity的解析。
8. 增加内部类结构解析。
9. 修改文档中显示的字段类型,float、double等由原来的number直接变成具体类型。

升级建议

这个版本相对之前的版本做了很多推导优化和功能更新,增加很多用户期待的书签式html格式Api文档,强烈建议升级到最新版本。

DEMO

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

相关文档

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

smart-doc功能使用介绍

项目wiki

原文  https://www.oschina.net/news/110725/smart-doc-1-7-2-released
正文到此结束
Loading...