ORPC项目v1.5.1版本发布:增强OpenAPI规范支持
ORPC是一个基于TypeScript的RPC框架,它通过Zod模式验证和OpenAPI规范支持,为开发者提供了类型安全的API开发体验。最新发布的v1.5.1版本主要增强了OpenAPI规范的支持能力,特别是引入了通用模式(Common Schemas)功能,使API文档更加规范和可重用。
通用模式(Common Schemas)功能详解
在API开发中,我们经常会遇到需要在多个接口中复用相同数据结构的情况。v1.5.1版本新增的通用模式功能允许开发者在OpenAPI规范中定义可重用的模式组件,这些组件可以在整个API规范中被引用。
基本用法
开发者现在可以通过commonSchemas选项来定义可重用的模式。每个模式可以指定不同的策略(strategy),目前支持三种方式:
- 默认策略:同时用于输入和输出
- 输入策略(input):仅用于请求体
- 输出策略(output):仅用于响应体
const UserSchema = z.object({
id: z.string(),
name: z.string(),
email: z.string().email(),
})
const spec = await generator.generate(router, {
commonSchemas: {
User: {
schema: UserSchema,
},
InputPet: {
strategy: 'input',
schema: PetSchema,
},
OutputPet: {
strategy: 'output',
schema: PetSchema,
},
},
})
技术实现细节
在底层实现上,ORPC会将这些通用模式转换为OpenAPI规范的components.schemas部分。这种设计有以下几个优势:
- 减少重复定义:相同的模式只需定义一次,多处引用
- 提高可维护性:修改模式定义时只需改动一处
- 增强文档可读性:生成的OpenAPI文档更加清晰规范
对于使用了Zod转换(transform)和管道(pipe)操作的模式,ORPC也能正确处理。例如在PetSchema中,将字符串ID转换为数字类型的处理会被正确地反映在生成的OpenAPI规范中。
其他改进
性能优化
v1.5.1版本还对服务器端的encodeHibernationRPCEvent函数进行了优化,提高了事件编码的效率。这对于高并发场景下的性能表现有积极影响。
Bug修复
修复了一个关于响应头处理的问题:当headers对象为可选时,OpenAPI生成器现在会正确地将响应头标记为可选,而不是强制要求。这使得API规范更加准确地反映了实际的接口行为。
总结
ORPC v1.5.1版本通过引入通用模式功能,进一步提升了API开发的类型安全性和文档规范性。这些改进使得开发者能够更高效地构建和维护高质量的API服务,特别是在需要严格遵循OpenAPI规范的场景下。性能优化和bug修复也提升了框架的稳定性和可靠性,为生产环境使用提供了更好的保障。
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00
jiuwenclawJiuwenClaw 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。Python0201- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
AtomGit城市坐标计划AtomGit 城市坐标计划开启!让开源有坐标,让城市有星火。致力于与城市合伙人共同构建并长期运营一个健康、活跃的本地开发者生态。01
awesome-zig一个关于 Zig 优秀库及资源的协作列表。Makefile00