【亲测免费】 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 StartedRust0211
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0135
JoyAI-EchoJoyAI-Echo,这是一个独立的、仅用于推理的版本,旨在实现分钟级多镜头音视频生成。它采用了经过蒸馏的DMD生成器、配对的跨模态记忆以及故事级别的一致性。其性能的核心在于,一个跨模态视听记忆库能够在长达五分钟的视频中保持角色外观和语音音色的一致性。同时,一个训练后处理流程将基于记忆的强化学习与分布匹配蒸馏相结合,实现了7.5倍的速度提升,显著增强了视觉质量和对齐效果。00
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
32
16
暂无描述
Dockerfile
774
5.07 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
871
2.01 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
468
461
Ascend Extension for PyTorch
Python
756
956
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
695
1.39 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.1 K
1.14 K
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.03 K
271
昇腾LLM分布式训练框架
Python
182
230
CANNBot 是面向 CANN 开发的用于提升开发效率的系列智能体,本仓库为其提供可复用的 Skills 模块。
Python
1.03 K
644