OpenAPI-TS 0.63.0版本发布:客户端插件化架构升级
2025-06-18 12:54:39作者:卓炯娓
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版本,建议开发者:
- 检查并更新配置文件中的客户端配置方式
- 更新所有直接引用客户端实例的导入语句
- 根据需要调整错误处理配置
- 测试生成的客户端代码是否正常工作
这次架构调整虽然带来了一些配置上的变化,但从长远来看,插件化的设计将为项目带来更好的可维护性和扩展性,同时也为未来支持更多类型的客户端实现奠定了基础。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C051
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0129
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
26
10
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
446
3.35 K
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19
暂无简介
Dart
702
166
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.24 K
681
React Native鸿蒙化仓库
JavaScript
278
329
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
15
1