8000 orpc/packages/openapi at main · tmcw/orpc · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

oRPC logo

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

@orpc/openapi

Generate OpenAPI specs and handle OpenAPI requests. Read the documentation for more information.

import { createServer } from 'node:http'
import { OpenAPIHandler } from '@orpc/openapi/node'
import { CORSPlugin } from '@orpc/server/plugins'

const handler = new OpenAPIHandler(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'))

Sponsors

License

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

0