@crumbjs/worker/README.md

<img src="https://raw.githubusercontent.com/tuplescompany/crumbjs/refs/heads/main/logo/crumbjs.png" alt="CrumbJS Logo" width="200"/> - The tasty way to build fast apis.

# @crumbjs/worker | Build, Validate & Document APIs. Fast (for the edge!)

<img src="https://raw.githubusercontent.com/tuplescompany/crumbjs/refs/heads/main/logo/crumbjs.png" alt="CrumbJS Logo" width="200"/>
- The tasty way to build fast apis.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[Full Documentation Page](https://crumbjs.com)

CrumbJS is a lightweight API framework. @crumbjs/worker is the Cloudflare Workers–ready build, derived from @crumbjs/core.

## Features

- Built on top of Radix3 FAST router [Rou3](https://github.com/h3js/rou3)
- Zod-based validation and types for bodies, queries, path params and headers
- Automatic OpenAPI 3.1 document generation and UI (Scalar -default- or Swagger)
- Simple middleware system and optional global middlewares
- Simple proxy helpers to forward requests and (optionally) document them (to an url or a cloudflare service binding)

## Documentation

[Full Documentation Page](https://crumbjs.com)

## Contribute

The best contribution is to **use CrumbJS in the wild**. If you want to go further:

- ⭐ Star the repo: https://github.com/tuplescompany/crumbjs
- 🐞 [Report a bug](https://github.com/tuplescompany/crumbjs/issues)
- 💡 [Request a feature](https://github.com/tuplescompany/crumbjs/issues/new?template=feature_request.md)
- 🧰 PRs welcome (small, focused changes)
- ☕ [Buy me a coffee](https://buymeacoffee.com/crumbjs)

Thanks for helping us keep the framework lean, type-safe, and fast to ship.