首页
/ Schemars 1.0.0-alpha.18 版本发布:JSON Schema 生成工具的重大更新

Schemars 1.0.0-alpha.18 版本发布:JSON Schema 生成工具的重大更新

2025-07-07 13:41:46作者:秋泉律Samson

Schemars 是一个强大的 Rust 库,用于自动生成 JSON Schema 定义。它通过 Rust 类型系统自动推导出对应的 JSON Schema,极大简化了 API 文档编写和数据验证的工作流程。最新发布的 1.0.0-alpha.18 版本带来了多项重要改进和新特性,标志着该项目向稳定版又迈进了一步。

核心特性增强

内联 Schema 支持

新版本引入了 #[schemars(inline)] 属性,这是一个重要的改进。在之前的版本中,Schema 的引用结构是固定的,现在开发者可以更灵活地控制 Schema 的生成方式。当应用于类型或字段时,这个属性会强制将相关 Schema 内联展开,而不是生成引用。这对于需要紧凑 Schema 结构的场景特别有用,可以减少生成的 JSON Schema 文件体积,提高可读性。

类型系统增强

对于基本整数类型(i8/i16/u8/u16)的 Schema 生成进行了改进,现在会自动包含 minimummaximum 属性。这一变化使得生成的 Schema 更加精确,能够更好地描述这些类型的取值范围。例如,u8 类型的 Schema 现在会明确指出其最小值为 0,最大值为 255。

可空类型处理重构

Option<T> 类型的处理进行了重大重构。之前的版本通过配置选项控制可空类型的表示方式,现在采用了更标准化的方法。生成的 Schema 总是包含 "null" 类型,开发者可以通过新增的 AddNullable 转换器将其改为 nullable 属性。这种改变使得 Schema 更加符合 JSON Schema 规范,同时保持了灵活性。

新功能亮点

格式限制转换器

新增的 RestrictFormats 转换器是一个实用的工具,它可以过滤掉不符合 JSON Schema 标准的 format 属性。在 API 文档生成过程中,这个功能特别有用,可以确保生成的 Schema 符合目标规范,避免使用特定实现的自定义格式。

类型名称包含功能

SchemaSettings 新增了 include_type_name 标志,启用后会在生成的 Schema 中添加 "x-rust-type" 属性,记录对应的 Rust 类型名称。这个功能对于调试和文档生成非常有用,可以清晰地追踪 Schema 与 Rust 类型的对应关系。

动态转换增强

dyn GenTransform 的功能进行了扩展,新增了类似 dyn Any 的操作方法,包括 isdowncast_refdowncast_mutdowncast。这些方法使得类型转换更加方便和安全,提高了转换器使用的灵活性。

兼容性与改进

该版本将最低支持的 Rust 版本(MSRV)提升至 1.74,利用了新版编译器的功能改进。同时,废弃了 GenTransform::as_any 方法,建议使用新的转换方法替代。

OpenAPI 3.0 元 Schema 的引用地址更新为活跃的 URL,确保长期可用性。SchemaSettings 中的 meta_schemadefinitions_path 字段类型从 String 改为 Cow<'static, str>,这使得在常量上下文中构建设置更加方便。

SchemaGenerator::take_definitions 方法新增了 apply_transforms 参数,允许在获取定义时选择性应用转换器,提供了更精细的控制能力。

总结

Schemars 1.0.0-alpha.18 版本在功能丰富性、规范符合性和使用便利性方面都有显著提升。特别是对可空类型处理的改进、内联 Schema 的支持以及格式限制功能的加入,使得这个 Rust JSON Schema 生成工具更加成熟和实用。这些改进为开发者提供了更强大的工具来生成精确、规范的 JSON Schema,同时保持了足够的灵活性以适应各种使用场景。随着项目向 1.0 稳定版迈进,Schemars 正在成为 Rust 生态中 JSON Schema 生成的事实标准解决方案。

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

热门内容推荐

最新内容推荐

项目优选

收起
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
757
475
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
150
238
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
318
1.04 K
Sa-TokenSa-Token
一个轻量级 java 权限认证框架,让鉴权变得简单、优雅! —— 登录认证、权限认证、分布式Session会话、微服务网关鉴权、SSO 单点登录、OAuth2.0 统一认证
Java
73
13
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
85
15
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
376
361
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
80
2
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
121
255
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.04 K
0
cjoycjoy
一个高性能、可扩展、轻量、省心的仓颉Web框架。Rest, 宏路由,Json, 中间件,参数绑定与校验,文件上传下载,MCP......
Cangjie
77
9