OpenAPI-TS 0.63.0版本发布:客户端插件化架构升级
2025-06-18 07:26:07作者:卓炯娓
OpenAPI-TS是一个强大的TypeScript代码生成工具,它能够根据OpenAPI规范自动生成类型安全的API客户端代码。这个工具极大地简化了前端开发人员与后端API交互的工作流程,确保类型安全的同时提高了开发效率。
客户端插件化架构
在0.63.0版本中,OpenAPI-TS进行了重大的架构调整,将客户端实现从核心功能中解耦,转变为插件化架构。这一变化带来了几个显著优势:
- 模块化设计:每个客户端实现现在都是一个独立的插件,使得代码结构更加清晰
- 灵活性增强:开发者可以根据项目需求选择特定的客户端实现,而不需要引入不必要的代码
- 更易维护:插件可以独立更新和发布,不影响核心功能
配置变更指南
对于使用配置文件的开发者,需要注意以下配置变更:
// 旧版配置
export default {
client: '@hey-api/client-fetch',
input: 'path/to/openapi.json',
output: 'src/client',
};
// 新版配置
export default {
input: 'path/to/openapi.json',
output: 'src/client',
plugins: ['@hey-api/client-fetch'],
};
错误处理配置迁移
throwOnError配置项从SDK层面迁移到了各个客户端插件中,这一变更更加合理,因为并非所有客户端都支持错误抛出机制。配置方式如下:
export default {
plugins: [
{
name: '@hey-api/client-fetch',
throwOnError: true, // 仅对支持该功能的客户端有效
}
]
};
客户端生成文件结构调整
新版本对生成的文件结构进行了优化调整:
- 客户端实例现在定义在
client.gen.ts文件中,而不是之前的sdk.gen.ts - 如果代码中有直接引用客户端实例,需要更新导入路径
// 旧版导入方式
import { client } from 'client/sdk.gen';
// 新版导入方式
import { client } from 'client/client.gen';
插件推断机制增强
新版本增加了插件推断失败时的错误提示,当配置中指定的插件无法找到时,会明确抛出错误,帮助开发者快速定位问题。
升级建议
对于现有项目升级到0.63.0版本,建议开发者:
- 检查并更新配置文件中的客户端配置方式
- 更新所有直接引用客户端实例的导入语句
- 根据需要调整错误处理配置
- 测试生成的客户端代码是否正常工作
这次架构调整虽然带来了一些配置上的变化,但从长远来看,插件化的设计将为项目带来更好的可维护性和扩展性,同时也为未来支持更多类型的客户端实现奠定了基础。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
MiniMax-M2暂无简介Jinja00
Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile014
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
deepin linux kernel
C
24
6
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
271
2.55 K
暂无简介
Dart
559
125
一个用于服务器应用开发的综合工具库。
- 零配置文件
- 环境变量和命令行参数配置
- 约定优于配置
- 深刻利用仓颉语言特性
- 只需要开发动态链接库,fboot负责加载、初始化并运行。
Cangjie
141
12
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
仓颉编程语言运行时与标准库。
Cangjie
127
104
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
357
1.84 K
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
434
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.03 K
606
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
731
70