OpenAPI-TS 0.63.0版本发布:客户端插件化架构升级
2025-06-18 21:17:37作者:卓炯娓
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版本,建议开发者:
- 检查并更新配置文件中的客户端配置方式
- 更新所有直接引用客户端实例的导入语句
- 根据需要调整错误处理配置
- 测试生成的客户端代码是否正常工作
这次架构调整虽然带来了一些配置上的变化,但从长远来看,插件化的设计将为项目带来更好的可维护性和扩展性,同时也为未来支持更多类型的客户端实现奠定了基础。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音(TTS)模型,代表了当前该领域的最高水平(SOTA),它直接在波形潜空间中进行操作。00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer(Mixture-of-Transformers, MoT) 架构,通过潜在令牌实现模态特异性计算,显著提升了细粒度感知能力。Jinja00
FreeSql功能强大的对象关系映射(O/RM)组件,支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。C#00
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
27
14
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
659
4.26 K
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
Ascend Extension for PyTorch
Python
503
609
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
391
286
暂无简介
Dart
905
218
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
昇腾LLM分布式训练框架
Python
142
168
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
939
862
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108