首页
/ Redocly/openapi-core 1.28.0版本发布:性能优化与规范更新

Redocly/openapi-core 1.28.0版本发布:性能优化与规范更新

2025-07-05 09:51:05作者:昌雅子Ethen

Redocly/openapi-core是Redocly生态系统中的一个核心组件,主要用于处理OpenAPI规范文档。作为一个强大的工具库,它提供了OpenAPI文档的解析、验证和转换等功能,是构建API文档工具链的重要基础。

主要变更:原生fetch API的采用

本次1.28.0版本最值得关注的改进是移除了对node-fetch依赖的使用,转而采用原生的fetch API。这一变更带来了多方面的优势:

  1. 性能提升:原生fetch API通常比第三方库有更好的性能表现,特别是在现代Node.js环境中
  2. 包体积减小:移除node-fetch依赖后,整个包的体积显著减小,这对于前端应用尤为重要
  3. 兼容性增强:原生fetch API已经成为现代JavaScript的标准,在Node.js 18+和浏览器环境中都有良好支持

对于开发者而言,这一变更意味着更轻量级的依赖和更好的运行时性能,特别是在处理大量API文档或进行频繁的网络请求时。

规范更新:移除body参数支持

根据Arazzo规范的最新要求,1.28.0版本移除了对in: body参数的支持。这一变更反映了现代API设计的最佳实践:

  1. OpenAPI 3.x版本已经推荐使用requestBody替代body参数
  2. 这种设计更符合RESTful API的设计原则
  3. 有助于保持API规范的简洁性和一致性

开发者需要注意,如果现有项目中仍在使用in: body参数,需要进行相应的迁移工作,改用requestBody来定义请求体。

类型定义优化

本次更新还对OAS 3.0和OAS 3.1的Schema类型定义进行了优化:

  1. 提供了更精确的类型提示
  2. 增强了类型安全性
  3. 改进了开发体验,特别是在TypeScript项目中

这些改进使得在使用Redocly/openapi-core进行开发时,能够获得更好的IDE支持和类型检查,减少潜在的运行时错误。

升级建议

对于现有项目,升级到1.28.0版本需要注意以下几点:

  1. 确保运行环境支持原生fetch API(Node.js 18+或现代浏览器)
  2. 检查项目中是否使用了将被移除的in: body参数
  3. 如果项目使用TypeScript,可以享受改进后的类型定义带来的好处

总的来说,Redocly/openapi-core 1.28.0版本通过采用现代Web标准、遵循最新API规范以及改进类型系统,为开发者提供了更高效、更可靠的OpenAPI处理能力。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
974
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133