smart-doc

[smartdoc647]

smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具，smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档，不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle 插件，然后按照规范写好 javadoc 注释即可生成 api 文档。同时 smart-doc 也支持生成 openapi 和 postman 这些规范的文档，生成后可以直接导入相关工具做测试。

仓库地址

https://github.com/TongchengOpenSource/smart-doc

Features

• 零注解、零学习成本、只需要写标准 JAVA 注释。
• 基于源代码接口定义自动推导，强大的返回结构推导。
• 支持 Spring MVC 、Spring Boot 、Spring Boot Web Flux(controller 书写方式)、Feign 。
• 支持 JAX-RS 实现的 WEB 框架，例如 Quarkus 。
• 支持 Callable 、Future 、CompletableFuture 等异步接口返回的推导。
• 支持 JavaBean 上的 JSR303 参数校验规范，包括分组验证。
• 对 JSON 请求参数的接口能够自动生成模拟 JSON 参数。
• 对一些常用字段定义能够生成有效的模拟值。
• 支持生成 JSON 返回值示例。
• 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。
• 支持生成多种格式文档：Markdown 、HTML5 、WORD 、Asciidoctor 、Postman Collection 、OpenAPI 3.0 。Up- 开放文档数据，可自由实现接入文档管理系统。
• 支持导出错误码和定义在代码中的各种字典码到接口文档。
• 支持 Maven 、Gradle 插件式轻松集成。
• 支持 Apache Dubbo RPC 接口文档生成。

重要更新内容

1. 支持分批上传文档到 torna#697
2. 支持提取 java record 的注释#703
3. 重构优化 word 模版，完全在 word 上实现了 markdown 样式的文档，生成的文档更漂亮 #710
4. 支持 @JsonSerialize(using = ToStringSerializer.class)字段类型的处理。 #715

本次社区共计合并的 pr 20+, 更多更新内容请查看 https://github.com/TongchengOpenSource/smart-doc/releases/tag/3.0.2

社区贡献

smart-doc 目前得到同程旅行的大力支持，对于社区贡献的 committer ，我们将提供书籍、文化衫等礼品作为奖励，非常鼓励大家参与共建。后续社区也会增加其他语言的支持。