【亲测免费】 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 团队将继续努力,为开发者提供更优质、更便捷的文档生成解决方案。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
最新内容推荐
基于MC1496的鉴相器资源文件介绍:一款强大的电子电路工具 macOS安装python3.8:轻松掌握Python环境配置【亲测免费】 YOLOv8系列--AI自瞄项目:实现高效目标检测的利器 BT1120规范资源下载介绍:数字视频信号传输的关键标准 sockperf网络测试工具及使用方法下载仓库 探索renren-fast2.1与renren-security3.2:轻量级权限管理系统的卓越之选 商用车智能底盘技术路线图 Linux服务器TDSQL单机安装指南:轻松部署高效数据库 SAP中文标准教材汇总资源下载说明 AUTOSAR_SWS_E2ELibrary资源文件介绍:汽车行业E2E通信标准化解决方案
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
522
3.71 K
Ascend Extension for PyTorch
Python
327
384
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
875
576
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
334
161
暂无简介
Dart
762
184
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.32 K
744
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
React Native鸿蒙化仓库
JavaScript
302
349
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
112
134