推荐使用 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(链接),以便亲身体验它所带来的便捷体验。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0265cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
73
63

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
922
551

飞桨多语言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

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8

React Native鸿蒙化仓库
C++
192
273

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16