SuperAPI AI 工具集

orpc

编程与开发

查看项目

更新于 10-16 09:35

技能介绍

用途:oRPC 是 TypeScript 的类型安全 API 层,结合 RPC 与 OpenAPI,适合创建或修改 API procedure(contract、router、handler)、搭建中间件(鉴权、授权守卫、日志)、与 Hono 等服务器框架集成、用 TanStack Query 构建数据获取 hook、用 event iterator/SSE 实现实时功能、配置客户端 link(fetch、WebSocket、batch、retry)以及处理错误(服务端 ORPCError、客户端类型化错误)。

主要能力:支持 Zod、Valibot、Arktype 或任意 Standard Schema 库。核心概念包括 Contract(oc,来自 @orpc/contract,无需 handler 即可定义 API 形状)、Procedure(os,来自 @orpc/server,含校验、中间件与依赖注入)、Router(普通对象,把 procedure 组织成树)、Middleware(os.middleware(),拦截、注入 context、访问守卫)、Handler(OpenAPIHandler/RPCHandler,通过 HTTP/WS 提供 procedure)、Client(createORPCClient + link)以及 TanStack Query(createTanstackQueryUtils)。

使用方式:项目按领域模块组织,contract 与 router 文件成对出现,根 barrel 组合各模块。contract-first 开发中,contract 定义 API 形状,router 用 implement(contract) 实现并由 TypeScript 强制约束。procedure 可链式调用 .use()、.input()、.output()、.handler(),其中 .handler 是唯一必需步骤,指定 .output 可提升 TypeScript 推断速度,也可创建可复用基类。中间件如 authMiddleware 可注入 user,输入感知中间件可实现授权守卫,中间件从左到右叠加,内置 onStart、onSuccess、onError、onFinish、dedupeMiddleware。错误处理可在服务端抛出 ORPCError,contract 可定义类型化错误,客户端用 safe 与 isDefinedError 处理。可集成 Hono(OpenAPIHandler)、TanStack Query(queries、mutations、infinite queries、key 失效),并用 event iterator 实现 SSE/流式,配合 EventPublisher 做类型化 pub/sub。客户端可用 RPCLink 配置 fetch 或 WebSocket link。

限制:资料未提供具体收费、价格、平台支持范围或性能数据;实际使用需参照其版本(v1.12+)与完整参考文档以获取高级模式、插件、文件上传、WebSocket、AI SDK 集成等细节。