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修复也提升了框架的稳定性和可靠性,为生产环境使用提供了更好的保障。
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~044CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0300- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选









