推荐使用 typed-openapi:打造类型安全的 TypeScript API 客户端
2024-06-11 22:02:03作者:魏侃纯Zoe
在现代 Web 开发中,快速、高效且类型安全地与 API 进行交互是至关重要的。这就是我们引入 typed-openapi 的原因,一个能够从 OpenAPI 规范自动生成 TypeScript API 客户端的工具。现在让我们一起探索这个强大工具的各项特性以及它能为你的开发工作带来哪些便利。
项目介绍
typed-openapi 是一款命令行工具,它可以解析你的 OpenAPI JSON 或 YAML 规范,并生成一个完全类型安全的客户端库,用于浏览器或 Node.js 环境。不仅如此,该项目还提供了一个在线 playground,便于你在网页上直接测试和试用生成的客户端代码。
项目技术分析
- 头状 API 客户端:允许你自由选择请求库,如 fetch、axios 或 ky。
- 类型驱动:默认情况下仅生成类型定义,以实现即时代码提示和错误检查。
- 运行时验证支持:除了纯类型版本,还可以选择集成多种验证库,包括 zod、typebox、arktype、valibot、io-ts 和 yup,以在运行时确保数据的有效性。
这个项目的核心在于其简洁且高效的代码生成机制,它基于 typebox-codegen 提供的验证模型。
项目及技术应用场景
- API 集成:当你需要与外部服务或微服务进行通信,而这些服务提供了 OpenAPI 描述时,使用 typed-openapi 可以快速构建出强大的 TypeScript 客户端。
- Web 应用开发:对于前端开发者,它可以在编码时提供准确的类型提示,减少因类型不匹配导致的错误。
- Node.js 后端应用:后端开发者可以利用 typed-openapi 构建内部服务间的通信客户端,保持代码整洁和类型安全。
- 快速原型制作:在设计阶段,你可以通过快速生成的客户端来模拟 API 调用,以验证接口设计。
项目特点
- 易用性:简单的命令行界面和清晰的文档使集成变得轻而易举。
- 高性能:专注于速度和类型安全,避免了大型 OpenAPI 规范可能导致的延迟问题。
- 灵活性:无绑定的 API 客户端设计,让你可以选择最适合你项目的请求库。
- 单一文件输出:生成的客户端代码是一个单一文件,易于管理和部署。
- 社区支持:尽管并非致力于全面支持 OpenAPI 规范,但其非目标导向使其更专注在关键功能,同时也欢迎社区贡献。
总的来说,如果你追求开发效率、类型安全性和代码质量,那么 typed-openapi 绝对值得你添加到你的工具箱中。现在就尝试安装并开始构建你的类型安全 API 客户端吧!
pnpm add typed-openapi
此外,别忘了探索在线 playground(链接),以便亲身体验它所带来的便捷体验。
登录后查看全文
热门项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C081
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python056
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提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0135
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
466
3.47 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
201
81
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
715
172
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
846
427
Ascend Extension for PyTorch
Python
275
311
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.26 K
695