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, ensuring a smooth and enjoyable developer experience.

Highlights

• End-to-End Type Safety 🔒: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
• First-Class OpenAPI 📄: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
• Contract-First Development 📜: (Optional) Define your API contract upfront and implement it with confidence.
• Exceptional Developer Experience ✨: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
• Multi-Runtime Support 🌍: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
• Framework Integrations 🧩: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
• Server Actions ⚡️: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
• Standard Schema Support 🗂️: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
• Fast & Lightweight 💨: Built on native APIs across all runtimes – optimized for speed and efficiency.
• Native Types 📦: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
• Lazy Router ⏱️: Improve cold start times with our lazy routing feature.
• SSE & Streaming 📡: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
• Reusability 🔄: Write once and reuse your code across multiple purposes effortlessly.
• Extendability 🔌: Easily enhance oRPC with plugins, middleware, and interceptors.
• Reliability 🛡️: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
• Simplicity 💡: Enjoy straightforward, clean code with no hidden magic.

Documentation

You can find the full documentation here.

Packages

• @rubenbupe/orpc-contract: Build your API contract.
• @rubenbupe/orpc-server: Build your API or implement API contract.
• @rubenbupe/orpc-client: Consume your API on the client with type-safety.
• @rubenbupe/orpc-react: Utilities for integrating oRPC with React and React Server Actions.
• @rubenbupe/orpc-react-query: Integration with React Query.
• @rubenbupe/orpc-vue-query: Integration with Vue Query.
• @rubenbupe/orpc-solid-query: Integration with Solid Query.
• @rubenbupe/orpc-svelte-query: Integration with Svelte Query.
• @rubenbupe/orpc-vue-colada: Integration with Pinia Colada.
• @rubenbupe/orpc-openapi: Generate OpenAPI specs and handle OpenAPI requests.
• @rubenbupe/orpc-zod: More schemas that Zod doesn't support yet.
• @rubenbupe/orpc-valibot: OpenAPI spec generation from Valibot.
• @rubenbupe/orpc-arktype: OpenAPI spec generation from ArkType.

@rubenbupe/orpc-client

Consume your API on the client with type-safety. Read the documentation for more information.

import { createORPCClient } from '@rubenbupe/orpc-client'
import { RPCLink } from '@rubenbupe/orpc-client/fetch'
import { ContractRouterClient } from '@rubenbupe/orpc-contract'
import { RouterClient } from '@rubenbupe/orpc-server'

const link = new RPCLink({
  url: 'http://localhost:3000/rpc',
  headers: () => ({
    authorization: 'Bearer token',
  }),
  // fetch: <-- provide fetch polyfill fetch if needed
})

// Create a client for your router
const client: RouterClient<typeof router> = createORPCClient(link)
// Or, create a client using a contract
const client: ContractRouterClient<typeof contract> = createORPCClient(link)

Sponsors

License

Distributed under the MIT License. See LICENSE for more information.