itty-router

Runtimes & Framework Support

Itty follows the Fetch API, and thus fits natively with any Web Standards server (e.g. Bun, Cloudflare Workers, Service Workers). That said, with a little effort, itty is compatible with virtually any modern runtime.

• Cloudflare Workers
• Bun
• Node
• Next.js

Cloudflare Workers

This is where it all began!

import { error, json, Router } from 'itty-router'

const router = Router()

router
  .get('/', () => 'Success!')
  .all('*', () => error(404))

export default {
  fetch: (req, ...args) => router
                            .handle(req, ...args)
                            .then(json)
                            .catch(error)
}

Bun

Needless to say, the Bun runtime, with its Web Standards support, is a fantastic pairing for itty!

import { error, json, Router } from 'itty-router'

const router = Router()

router
  .get('/', () => 'Success!')
  .all('*', () => error(404))

export default {
  port: 3001,
  fetch: (request) => router
                        .handle(request)
                        .then(json)
                        .catch(error)
}

Node

The aging Node.js runtime takes a bit more work compared to more modern enviornments, but thanks to the nice @whatwg-node/server adapter, this is still easily hooked up.

import 'isomorphic-fetch'
import { createServerAdapter } from '@whatwg-node/server'
import { createServer } from 'http'
import { error, json, Router } from 'itty-router'

const router = Router()

router
  .get('/', () => 'Success!')
  .all('*', () => error(404))

// create a @whatwg-node/server
const ittyServer = createServerAdapter(
  (request, env, ctx) => router
                          .handle(request, env, ctx)
                          .then(json)
                          .catch(error)
)

// Then use it in any environment
const httpServer = createServer(ittyServer)
httpServer.listen(3001)

Next.js

To integrate itty router openapi with Next.js, you can create a custom API route that captures all requests. For instance, you might have a route like app/api/gpt/[slug].ts.

In Next.js 14, to intercept GET and POST requests and pass them to itty router, you need to set up your API routes to forward these requests to therouter. This can be done by returning router.handle(req) within your API route handlers.

import { Router } from 'itty-router'

const router = Router()

router.get('/', () => 'Success!')
router.all('*', () => new Response('404 Not Found...', { status: 200 }))

export async function POST(req) {
  return router.handle(req)
}

export async function GET(req) {
  return router.handle(req)
}