首页
/ Smart-Doc 3.1.1版本发布:API文档生成工具的重大升级

Smart-Doc 3.1.1版本发布:API文档生成工具的重大升级

2025-07-01 06:42:35作者:卓艾滢Kingsley

Smart-Doc是一款基于Java源代码分析的API文档生成工具,它能够自动从代码注释中提取信息并生成多种格式的API文档。相比于传统的Swagger等工具,Smart-Doc不需要在代码中添加注解,而是直接解析源代码和注释,这使得它更加轻量级且对代码无侵入性。

核心功能增强

本次3.1.1版本在文档生成的核心功能上做了多项重要改进。首先是对Word和HTML文档中特殊字符的转义处理进行了重构,新的WordXmlEscape和HtmlEscape类提供了更健壮的处理机制,确保生成的文档在各种环境下都能正确显示特殊字符。

在OpenAPI规范支持方面,新增了AbstractOpenApiBuilder抽象类,为开发者提供了更灵活的OpenAPI规范生成方式。同时,现在可以根据方法描述或包名自动生成API标签,使得生成的OpenAPI文档结构更加清晰合理。

验证与示例生成优化

针对参数验证的支持,本次更新增加了对默认验证消息占位符的支持。这意味着当开发者使用验证框架(如Hibernate Validator)时,Smart-Doc能够更准确地解析和展示验证规则和错误消息。

在示例值生成方面,修复了之前总是生成字符串类型示例的问题。现在Smart-Doc会根据字段的实际类型生成合适的示例值,例如对于数值类型会生成数字示例,对于布尔类型会生成true/false示例,这使得生成的文档示例更加贴近实际使用场景。

引用处理与配置增强

对于复杂的数据模型,Smart-Doc新增了allowSelfReference配置项,允许开发者控制是否允许模型自引用。这在处理树形结构或图状数据结构时特别有用,开发者可以根据需要选择是否展开自引用关系。

在方法过滤方面,新增了判断方法是否应该被跳过文档生成的能力。这使得开发者可以更灵活地控制哪些方法需要生成文档,哪些方法应该被排除在外,特别适合处理内部方法或框架自动生成的方法。

问题修复与稳定性提升

本次版本修复了多个关键问题,包括Map类型键类型检查错误、响应字段使用泛型时文档生成错误等问题。这些修复显著提升了工具在处理复杂Java类型时的稳定性和准确性。

在模板处理方面,改进了Beetl模板的类加载机制,确保在不同环境下模板都能正确加载和渲染。同时优化了错误报告描述,使得当文档生成出现问题时,开发者能够更快速准确地定位问题原因。

总结

Smart-Doc 3.1.1版本通过多项功能增强和问题修复,进一步巩固了其作为轻量级API文档生成工具的地位。新版本在OpenAPI规范支持、验证消息处理、示例值生成等方面都有显著改进,同时提升了工具的稳定性和灵活性。对于追求代码整洁、希望减少注解污染的Java开发者来说,Smart-Doc无疑是一个值得考虑的API文档解决方案。

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

最新内容推荐

项目优选

收起
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
136
187
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
884
523
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
362
381
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
182
264
kernelkernel
deepin linux kernel
C
22
5
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.09 K
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
84
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
613
60
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
118
78