首页
/ 【亲测免费】 Smart-doc:Java REST API 文档生成工具

【亲测免费】 Smart-doc:Java REST API 文档生成工具

2026-01-29 12:34:26作者:彭桢灵Jeremy

Smart-doc 是一款基于 Java 语言的开源项目,主要用于生成 Java REST API 文档。该项目采用 Java 作为主要的编程语言,旨在通过接口源代码分析,实现零注解侵入的方式来生成接口文档。

核心功能

Smart-doc 的核心功能包括:

  • 零注解侵入:在开发过程中,只需要编写标准的 Java 文档注释,无需在代码中添加任何注解。
  • 自动生成文档:基于源代码接口定义,自动生成文档。
  • 强大的返回结构推导支持:支持多种返回结构推导。
  • 兼容多种框架:支持 Spring MVC、Spring Boot、Spring Boot Web Flux(不支持 endpoint)、Feign、JAX-RS 等框架。
  • 参数验证:支持 JSR-303 参数验证规范。
  • 请求示例生成:基于请求参数,自动生成请求示例。
  • JSON 返回值示例生成:生成 JSON 返回值示例。
  • 多格式文档支持:支持生成 Markdown、HTML5、Word、Asciidoctor、Postman Collection、OpenAPI 3.0 等格式的文档。
  • 性能测试脚本生成:支持生成 JMeter 性能测试脚本。
  • 错误码和数据字典导出:支持将错误码和数据字典导出到 API 文档。
  • 文件上传和下载测试:调试 HTML5 页面支持文件上传和下载测试。
  • Apache Dubbo RPC 支持:支持 Apache Dubbo RPC。
  • gRPC 最佳实践:结合 gRPC 实现最佳实践。

最近更新功能

Smart-doc 的最近更新包含以下功能:

  • 优化了文档生成的性能和稳定性。
  • 增加了对 Spring Boot Web Flux 的支持(但不支持 endpoint)。
  • 支持将文档自动推送到 Torna 企业级接口文档管理平台。
  • 提供了更多格式的文档输出选项。
  • 修复了一些已知的问题,提升了用户体验。

Smart-doc 以其高效、简洁的文档生成方式,成为了许多开发者的首选工具。在未来,Smart-doc 团队将继续努力,为开发者提供更优质、更便捷的文档生成解决方案。

登录后查看全文
热门项目推荐
相关项目推荐