首页 > 开源 > oRPC 让 TypeScript 类型安全 API 开发变得简单无代码生成,覆盖 Node、Bun、Deno 等多平台

oRPC 让 TypeScript 类型安全 API 开发变得简单无代码生成,覆盖 Node、Bun、Deno 等多平台

AI垂直社区 2026-11-19 18:03 32 阅读 查看原文

oRPC 是一个创新的 TypeScript 框架,旨在彻底改变开发者构建类型安全 API's 方式。通过纯 TypeScript 函数定义 API 契约,项目自动生成完整的类型校验客户端、 OpenAPI 3 文档和 AI 代理工具,无需任何代码生成步骤。支持运行于 Node.js、Bun、Deno、Cloudflare Workers 等现代 Java base runtime,兼容 React、Vue、Svelte 等前端生态。其独特的 contract-first 设计确保 API 开发过程中的类型安全、文档自动生成和端到heads 一致性,极大地提升了开发者生产力。项目目前已收获 5773 星,表明社区对其创新性解决方案的高度认可。

适用人群:TypeScript 开发者,Full-stack 工程师,AI 应用开发者

适用场景:构建类型安全微服务,生成 OpenAPI 文档,创建 AI 代理工具

推荐理由:oRPC 通过无代码生成的理念,打破了传统 API 开发工具的藩篱,让开发者能够专注于业务逻辑而非重复的类型声明。无论是构建企业级服务还是快速交付原型,其类型安全和多平台支持都能显著降低跨团队协作成本。此外,项目提供的 OpenAPI 文档和 MCP 工具支持,让 API 不仅能服务传统客户端,也能轻松接入 AI 代理,满足当前 AI 驱动应用的发展需求。选择 oRPC,等同于选择一条未来-proof 的 API 开发之路。

项目定位与背景

随着微服务架构的普及,API 的类型安全和文档自动化已成为团队面临的核心挑战。传统方案如 tRPC、URPC 等虽然提供了类型安全,但往往需要代码生成或复杂的配置,导致开发体验不流畅。middleapi/orpc 项目旨在提供一种全新的 contract-first 方法,通过纯 TypeScript 函数定义 API 契约,直接实现端到端的类型安全。项目不仅支持服务器端 RPC 路由,还自动生成客户端类型、 OpenAPI 3 文档和 AI 代理工具,真正实现 "写一次,用一生" 的理念。其支持 Node.js、Bun、Deno、Cloudflare Workers 等现代运行时,也体现了对当前多元化开发环境的深刻理解。

核心功能与技术架构

服务端路由与处理器

oRPC 采用类似路由树的结构,开发者通过 `os` 对象定义输入验证(基于 Zod)和处理函数。例如,定义 `planet.find` 路由时,输入验证使用 Zod 模式,确保编译时期类型校验。处理函数接收结构化输入,返回任意 JSON 可序列化结果。

客户端自动类型推导

通过 `createORPCClient` 和 `RPCLink`,客户端可以自动获得与服务端路由完全匹配的类型,即使 API 发生变更,客户端代码也能即时同步,免去手动维护类型映射表的麻烦。

OpenAPI 3 文档自动生成

项目内置 OpenAPI 文档生成器,能够从 TypeScript 类型中推导出完整的 API 文档,支持 swagger UI 等工具,直接提升 API 可观测性和交互性。

MCP 工具支持

为 AI 代理提供结构化工具调用,开发者无需额外配置,即可将 API 暴露为 AI 可操作工具, bridging AI 与后端服务。

多平台运行时支持

统一抽象层确保相同代码可在 Node.js、Bun、Deno、Cloudflare Workers 等环境无缝运行,满足 Serverless、Edge Function 等使用场景。

创新点与亮点

零代码生成:摒绝传统工具需要双向代码生成的模式,完全通过类型推导实现双向类型安全。
2. 深度 TypeScript 集成: 充分利用 TS 4.5+ 特征,如条件类型、映射类型等,确保类型精确表达 API 契约。
3. 多端一致性: 服务端、客户端、文档和 MCP 工具同时生成,保证一致性。
4. 灵活验证框架: 默认集成 Zod,也支持其他验证方案,满足不同团队偏好。
5. 高性能运行时: 轻量级抽象,运行时开销极小,适合高频请求场景。

与同类项目的对比

| 功能 | oRPC | tRPC | URPC |
|------|------|------|------|
| 代码生成 | 无 | 有 | 有 |
| 类型安全 | 双向 | 服务端 | 客户端 |
| OpenAPI 自动生成 | 支持 | 需额外插件 | 不支持 |
| MCP 支持 | 内置 | 无 | 无 |
| 运行时支持 | Node、Bun、Deno、CFW | Node、浏览器 | Node |

相比之下,oRPC 在零代码生成、双向类型安全和多平台支持方面更具优势,尤其在 AI 代理工具集成方面更领先。

上手指南与快速开始

安装核心包:`npm install @orpc/server @orpc/client @orpc/client/fetch`
2. 创建服务端路由文件,导入 `os` 和验证库,定义路由器对象。
3. 启动服务器,挂载 `os` 路由到 `/rpc` 路径。
4. 客户端导入路由器类型,创建 `RPCLink` 并通过 `createORPCClient` 生成类型安全的客户端。
5. 调用客户端方法,IDE 将提示所有可用参数和返回类型。
6. 访问 `/rpc` + `/openapi.json` 获取自动生成的 OpenAPI 文档。

整个流程无需额外的配置文件或代码生成工具,从零到有的速度极快。

总结与展望

oRPC 作为一款新型 TypeScript API 构建框架,成功解决了类型安全与开发效率之间的矛盾。其 zero-code-generation 理念开创了 API 开发的新范式,尤其适合追求极致开发者体验的团队。未来,随着 AI 应用的蓬勃发展,oRPC 在 MCP 工具方面的领先地位将更加凸显。此外,项目计划扩展对更多运行时(如 Edge 容器)的支持,并进一步优化 TypeScript 编译性能。随着社区的不断壮大,oRPC 有望成为构建现代、类型安全、智能化 API's 的首选工具。

项目信息

项目名称 middleapi/orpc
编程语言 TypeScript
Star 数 5773
Fork 数 177
主题标签 api, bunjs, cloudflare-worker, contract-first, denojs, next-js, nodejs, openapi, openapi3, pinia-vuejs, react, rpc-api, solidjs, svelte, tanstack, typesafe, typescript, vue
查看 GitHub 项目
https://github.com/middleapi/orpc