推荐使用 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(链接),以便亲身体验它所带来的便捷体验。
登录后查看全文
热门项目推荐
ERNIE-4.5-VL-28B-A3B-ThinkingERNIE-4.5-VL-28B-A3B-Thinking 是 ERNIE-4.5-VL-28B-A3B 架构的重大升级,通过中期大规模视觉-语言推理数据训练,显著提升了模型的表征能力和模态对齐,实现了多模态推理能力的突破性飞跃Python00
Kimi-K2-ThinkingKimi K2 Thinking 是最新、性能最强的开源思维模型。从 Kimi K2 开始,我们将其打造为能够逐步推理并动态调用工具的思维智能体。通过显著提升多步推理深度,并在 200–300 次连续调用中保持稳定的工具使用能力,它在 Humanity's Last Exam (HLE)、BrowseComp 等基准测试中树立了新的技术标杆。同时,K2 Thinking 是原生 INT4 量化模型,具备 256k 上下文窗口,实现了推理延迟和 GPU 内存占用的无损降低。Python00
MiniMax-M2MiniMax-M2是MiniMaxAI开源的高效MoE模型,2300亿总参数中仅激活100亿,却在编码和智能体任务上表现卓越。它支持多文件编辑、终端操作和复杂工具链调用Python00
HunyuanVideo-1.5暂无简介00
MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00
Spark-Formalizer-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
最新内容推荐
操作系统概念第六版PDF资源全面指南:适用场景与使用教程 高效汇编代码注入器:跨平台x86/x64架构的终极解决方案 高效验证码识别解决方案:OCRServer资源文件深度解析与应用指南 PhysioNet医学研究数据库:临床数据分析与生物信号处理的权威资源指南 STDF-View解析查看软件:半导体测试数据分析的终极工具指南 海能达HP680CPS-V2.0.01.004chs写频软件:专业对讲机配置管理利器 MQTT 3.1.1协议中文版文档:物联网开发者的必备技术指南 IK分词器elasticsearch-analysis-ik-7.17.16:中文文本分析的最佳解决方案 Python开发者的macOS终极指南:VSCode安装配置全攻略 Windows Server 2016 .NET Framework 3.5 SXS文件下载与安装完整指南
项目优选
收起
deepin linux kernel
C
24
7
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
375
3.25 K
暂无简介
Dart
619
140
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
62
19
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.03 K
479
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
647
261
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.09 K
619
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
790
76