【亲测免费】 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 团队将继续努力,为开发者提供更优质、更便捷的文档生成解决方案。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0153- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0112
热门内容推荐
最新内容推荐
项目优选
收起
暂无描述
Dockerfile
733
4.75 K
Ascend Extension for PyTorch
Python
649
795
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
434
395
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.01 K
1.01 K
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.24 K
153
deepin linux kernel
C
30
16
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
146
237
暂无简介
Dart
985
252
昇腾LLM分布式训练框架
Python
166
198
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.68 K
989