Package Exports
- @crumbjs/core
- @crumbjs/core/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@crumbjs/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@crumbjs/core | Build, Validate & Document APIs. Fast.
- The tasty way to build fast apis.
CrumbJS is a lightweight API framework for Bun focused on backend development. It layers configuration, validation and documentation on top of Bun's built-in router while keeping a familiar Express-like developer experience. Validation is powered by Zod and every route can be automatically documented through OpenAPI.
The core system has only about 3,700 lines of code and just two dependencies (zod and openapi3-ts).
Features
- Built for Bun.serve and only targets backend APIs
- Zod-based validation for bodies, queries, path params and headers
- Automatic OpenAPI 3.1 document generation and UI (Scalar -default- or Swagger)
- Auto-generate type-safe clients (eg. for frontend), with zero allocations.
- Simple middleware system and optional global middlewares
- Simple proxy helpers to forward requests and (optionally) document them.
Included middlewares
- cors
- signals (log incomming request)
- secureHeaders
Official Plugins
- @crumbjs/bullmq -> Bullmq worker aside CrumbJS server. For simple redis queue system
- @crumbjs/mongo -> Mongo connection handler, AUTO-CRUD! and simple repository provider based on zod
Documentation
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
- 💡 Request a feature
- 🧰 PRs welcome (small, focused changes)
- ☕ Buy me a coffee
Thanks for helping us keep the framework lean, type-safe, and fast to ship.