Typesafe APIs Made Simple 🪄

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

Highlights

• 🔗 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.
• 🔍 First-Class OpenTelemetry: Seamlessly integrate with OpenTelemetry for observability.
• ⚙️ Framework Integrations: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, 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.

Documentation

You can find the full documentation here.

Packages

• @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/openapi: Generate OpenAPI specs and handle OpenAPI requests.
• @orpc/otel: OpenTelemetry integration for observability.
• @orpc/nest: Deeply integrate oRPC with NestJS.
• @orpc/react: Utilities for integrating oRPC with React and React Server Actions.
• @orpc/tanstack-query: TanStack Query integration.
• @orpc/experimental-react-swr: SWR integration.
• @orpc/vue-colada: Integration with Pinia Colada.
• @orpc/hey-api: Hey API integration.
• @orpc/zod: More schemas that Zod doesn't support yet.
• @orpc/valibot: OpenAPI spec generation from Valibot.
• @orpc/arktype: OpenAPI spec generation from ArkType.

Overview

This is a quick overview of how to use oRPC. For more details, please refer to the documentation.

1. Define your router:

```ts import type { IncomingHttpHeaders } from 'node:http' import { ORPCError, os } from '@orpc/server' import * as 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 } } ```

1. Create your server:

```ts 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 127.0.0.1:3000') ) ```

1. Create your client:

```ts 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 = createORPCClient(link) ```

1. Consume your API:

```ts import { orpc } from './client'

const planets = await orpc.planet.list({ limit: 10 }) ```

1. Generate OpenAPI Spec:

```ts import { OpenAPIGenerator } from '@orpc/openapi' import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4'

const generator = new OpenAPIGenerator({ schemaConverters: [new ZodToJsonSchemaConverter()] })

const spec = await generator.generate(router, { info: { title: 'Planet API', version: '1.0.0' } })

console.log(spec) ```

Sponsors

If you find oRPC valuable and would like to support its development, you can do so here: GitHub Sponsors.

🏆 Platinum Sponsor

ScreenshotOne.com

🥈 Silver Sponsor

村上さん

🥉 Bronze Sponsor

plancraft

Generous Sponsors

LN Markets

Sponsors

Reece McDonald	nk	supastarter	Dexter Miguel	herrfugbaum	Ryota Murakami	David Cramer
Valerii Petryniak	Valerii Strilets	Kyle Mistele	Andrew Peters	Ryan Vogel	christ12938	Peter Adam
Ryan Soderberg	shota

Backers

David Walsh

Adam Tkaczyk