推荐使用 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(链接),以便亲身体验它所带来的便捷体验。
登录后查看全文
热门项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00- QQwen3-Coder-Next2026年2月4日,正式发布的Qwen3-Coder-Next,一款专为编码智能体和本地开发场景设计的开源语言模型。Python00
xw-cli实现国产算力大模型零门槛部署,一键跑通 Qwen、GLM-4.7、Minimax-2.1、DeepSeek-OCR 等模型Go06
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin08
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
537
3.75 K
暂无简介
Dart
773
191
Ascend Extension for PyTorch
Python
343
406
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.34 K
755
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.07 K
97
React Native鸿蒙化仓库
JavaScript
303
355
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
337
180
AscendNPU-IR
C++
86
141
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
986
248