首页
/ OpenAPI-TS 0.63.0版本发布:客户端插件化架构升级

OpenAPI-TS 0.63.0版本发布:客户端插件化架构升级

2025-06-18 12:30:28作者:卓炯娓

OpenAPI-TS是一个强大的TypeScript代码生成工具,它能够根据OpenAPI规范自动生成类型安全的API客户端代码。这个工具极大地简化了前端开发人员与后端API交互的工作流程,确保类型安全的同时提高了开发效率。

客户端插件化架构

在0.63.0版本中,OpenAPI-TS进行了重大的架构调整,将客户端实现从核心功能中解耦,转变为插件化架构。这一变化带来了几个显著优势:

  1. 模块化设计:每个客户端实现现在都是一个独立的插件,使得代码结构更加清晰
  2. 灵活性增强:开发者可以根据项目需求选择特定的客户端实现,而不需要引入不必要的代码
  3. 更易维护:插件可以独立更新和发布,不影响核心功能

配置变更指南

对于使用配置文件的开发者,需要注意以下配置变更:

// 旧版配置
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, // 仅对支持该功能的客户端有效
    }
  ]
};

客户端生成文件结构调整

新版本对生成的文件结构进行了优化调整:

  1. 客户端实例现在定义在client.gen.ts文件中,而不是之前的sdk.gen.ts
  2. 如果代码中有直接引用客户端实例,需要更新导入路径
// 旧版导入方式
import { client } from 'client/sdk.gen';

// 新版导入方式
import { client } from 'client/client.gen';

插件推断机制增强

新版本增加了插件推断失败时的错误提示,当配置中指定的插件无法找到时,会明确抛出错误,帮助开发者快速定位问题。

升级建议

对于现有项目升级到0.63.0版本,建议开发者:

  1. 检查并更新配置文件中的客户端配置方式
  2. 更新所有直接引用客户端实例的导入语句
  3. 根据需要调整错误处理配置
  4. 测试生成的客户端代码是否正常工作

这次架构调整虽然带来了一些配置上的变化,但从长远来看,插件化的设计将为项目带来更好的可维护性和扩展性,同时也为未来支持更多类型的客户端实现奠定了基础。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
73
63
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
922
551
PaddleOCRPaddleOCR
飞桨多语言OCR工具包(实用超轻量OCR系统,支持80+种语言识别,提供数据标注与合成工具,支持服务器、移动端、嵌入式及IoT设备端的训练与部署) Awesome multilingual OCR toolkits based on PaddlePaddle (practical ultra lightweight OCR system, support 80+ languages recognition, provide data annotation and synthesis tools, support training and deployment among server, mobile, embedded and IoT devices)
Python
47
1
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16