oRPC 是结合 RPC 与 OpenAPI 的端到端类型安全 API 方案(v1.12+),支持 Zod、Valibot、Arktype 或任意 Standard Schema 库。本技能适用于创建或修改 API 过程(契约、路由、处理器)、设置中间件(认证、授权守卫、日志)、将 oRPC 集成到 Hono 等服务器框架、用 TanStack Query 构建数据获取钩子、用事件迭代器/SSE 实现实时功能、配置客户端链接(fetch、WebSocket、批量、重试)以及处理错误(服务端 ORPCError、客户端类型化错误)。
核心概念:Contract(oc,来自 @orpc/contract,定义无处理器的 API 形状);Procedure(os,来自 @orpc/server,含校验、中间件与依赖注入的函数);Router(普通对象,将过程组合成树);Middleware(os.middleware(),拦截、注入上下文、守卫访问);Handler(OpenAPIHandler / RPCHandler,通过 HTTP/WS 提供过程);Client(createORPCClient + link,从契约/路由生成类型安全客户端);TanStack Query(createTanstackQueryUtils,React 查询/变更钩子)。
使用方式:项目按领域模块组织,契约与路由文件成对存放,根 barrel 组合各模块。契约优先:先定义输入输出形状,再用 implement 实现并受 TypeScript 约束。过程用 .use、.input、.output、.handler 链式定义,其中 .handler 是唯一必需步骤,指定 .output 可提升推导速度。中间件可注入用户、按输入做权限守卫,并支持 onStart、onSuccess、onError、onFinish、dedupeMiddleware 等内置能力。错误通过 ORPCError 抛出,契约可定义类型化错误。集成方面提供 Hono 处理器示例、TanStack Query 的查询/变更/无限查询与失效 key、事件迭代器(SSE/流式)以及 fetch/WebSocket 客户端链接。
限制:资料未提供收费、价格、平台支持等具体信息,暂未提供相关内容。