【亲测免费】 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 StartedRust099- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
热门内容推荐
最新内容推荐
跨系统应用融合:APK Installer实现Windows环境下安卓应用运行的技术路径探索如何用OpCore Simplify构建稳定黑苹果系统?掌握这3大核心策略ComfyUI-LTXVideo实战攻略:3大核心场景的视频生成解决方案告别3小时抠像噩梦:AI如何让人人都能制作电影级视频Anki Connect:知识管理与学习自动化的API集成方案Laigter法线贴图生成工具零基础实战指南:提升2D游戏视觉效率全攻略如何用智能助手实现高效微信自动回复?全方位指南3步打造高效游戏自动化工具:从入门到精通的智能辅助方案掌握语音分割:从入门到实战的完整路径开源翻译平台完全指南:从搭建到精通自托管翻译服务
项目优选
收起
deepin linux kernel
C
28
16
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
570
99
暂无描述
Dockerfile
709
4.51 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
958
955
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.61 K
942
Ascend Extension for PyTorch
Python
572
694
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
413
339
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.42 K
116
暂无简介
Dart
951
235
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
2