oRPC is a powerful combination of RPC and OpenAPI, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
- 🔗 End-to-End Type Safety: Ensure type-safe inputs, outputs, and errors from client to server.
- 📘 First-Class OpenAPI: Built-in support that fully adheres to the OpenAPI standard.
- 📝 Contract-First Development: Optionally define your API contract before implementation.
- ⚙️ Framework Integrations: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
- 🚀 Server Actions: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
- 🔠 Standard Schema Support: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
- 🗃️ Native Types: Supports native types like Date, File, Blob, BigInt, URL, and more.
- ⏱️ Lazy Router: Enhance cold start times with our lazy routing feature.
- 📡 SSE & Streaming: Enjoy full type-safe support for SSE and streaming.
- 🌍 Multi-Runtime Support: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
- 🔌 Extendability: Easily extend functionality with plugins, middleware, and interceptors.
- 🛡️ Reliability: Well-tested, TypeScript-based, production-ready, and MIT licensed.
You can find the full documentation here.
- @orpc/contract: Build your API contract.
- @orpc/server: Build your API or implement API contract.
- @orpc/client: Consume your API on the client with type-safety.
- @orpc/react: Utilities for integrating oRPC with React and React Server Actions.
- @orpc/react-query: Integration with React Query.
- @orpc/vue-query: Integration with Vue Query.
- @orpc/solid-query: Integration with Solid Query.
- @orpc/svelte-query: Integration with Svelte Query.
- @orpc/vue-colada: Integration with Pinia Colada.
- @orpc/openapi: Generate OpenAPI specs and handle OpenAPI requests.
- @orpc/zod: More schemas that Zod doesn't support yet.
- @orpc/valibot: OpenAPI spec generation from Valibot.
- @orpc/arktype: OpenAPI spec generation from ArkType.
This is a quick overview of how to use oRPC. For more details, please refer to the documentation.
-
Define your router:
import type { IncomingHttpHeaders } from 'node:http' import { ORPCError, os } from '@orpc/server' import { z } from 'zod' const PlanetSchema = z.object({ id: z.number().int().min(1), name: z.string(), description: z.string().optional(), }) export const listPlanet = os .input( z.object({ limit: z.number().int().min(1).max(100).optional(), cursor: z.number().int().min(0).default(0), }), ) .handler(async ({ input }) => { // your list code here return [{ id: 1, name: 'name' }] }) export const findPlanet = os .input(PlanetSchema.pick({ id: true })) .handler(async ({ input }) => { // your find code here return { id: 1, name: 'name' } }) export const createPlanet = os .$context<{ headers: IncomingHttpHeaders }>() .use(({ context, next }) => { const user = parseJWT(context.headers.authorization?.split(' ')[1]) if (user) { return next({ context: { user } }) } throw new ORPCError('UNAUTHORIZED') }) .input(PlanetSchema.omit({ id: true })) .handler(async ({ input, context }) => { // your create code here return { id: 1, name: 'name' } }) export const router = { planet: { list: listPlanet, find: findPlanet, create: createPlanet } }
-
Create your server:
import { createServer } from 'node:http' import { RPCHandler } from '@orpc/server/node' import { CORSPlugin } from '@orpc/server/plugins' const handler = new RPCHandler(router, { plugins: [new CORSPlugin()] }) const server = createServer(async (req, res) => { const result = await handler.handle(req, res, { context: { headers: req.headers } }) if (!result.matched) { res.statusCode = 404 res.end('No procedure matched') } }) server.listen( 3000, '127.0.0.1', () => console.log('Listening on 78A8 127.0.0.1:3000') )
-
Create your client:
import type { RouterClient } from '@orpc/server' import { createORPCClient } from '@orpc/client' import { RPCLink } from '@orpc/client/fetch' const link = new RPCLink({ url: 'http://127.0.0.1:3000', headers: { Authorization: 'Bearer token' }, }) export const orpc: RouterClient<typeof router> = createORPCClient(link)
-
Consume your API:
import { orpc } from './client' const planets = await orpc.planet.list({ limit: 10 })
-
Generate OpenAPI Spec:
import { OpenAPIGenerator } from '@orpc/openapi' import { ZodToJsonSchemaConverter } from '@orpc/zod' const generator = new OpenAPIGenerator({ schemaConverters: [new ZodToJsonSchemaConverter()] }) const spec = await generator.generate(router, { info: { title: 'Planet API', version: '1.0.0' } }) console.log(spec)
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
- tRPC: For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
- ts-rest: For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC’s feature set.
Distributed under the MIT License. See LICENSE for more information.