gem-hunter
主要言語: TypeScript
burger-api is a modern, open source API framework built on Bun.js. It combines the simplicity of file-based routing with powerful features like built-in middleware, Zod-based schema validation, and automatic OpenAPI generation.
A modern, high-performance API framework built on Bun.js
This monorepo contains the burger-api ecosystem - a modern, open-source API framework built on Bun.js. The framework combines the simplicity of file-based routing with powerful features like built-in middleware, Zod-based schema validation, and automatic OpenAPI generation.
This project is under active development and should not be used in production yet. 📌 Releases: burger-api 0.9.7 · @burger-api/cli 0.9.8 (May 16, 2026).
This monorepo is organized into the following packages:
The core burger-api framework package. This is the main framework that gets published to npm.
packages/cliThe Burger API CLI tool for scaffolding new burger-api projects and managing your development workflow.
Option 1: Bun Global Installation (Recommended if you have Bun installed)
# Global installation bun add -g @burger-api/cli # Or use with bunx (No Installation Needed) bunx @burger-api/cli create my-project
Option 2: Standalone Executable
macOS, Linux, WSL:
curl -fsSL https://burger-api.com/install.sh | bashWindows PowerShell:
irm https://burger-api.com/install.ps1 | iex
Or download the executable from GitHub Releases.
Package Details:
@burger-api/cliFor detailed documentation, see
packages/cli/README.md.
Install dependencies for all packages:
bun install
# Work on burger-api framework cd packages/burger-api # Work on CLI cd packages/cli
# Typecheck burger-api bun run typecheck # Build burger-api bun run build # Full suite: route-sync + framework (examples + ecosystem smoke) + CLI + typecheck bun run test:all # Framework package only (examples + ecosystem middleware smoke tests) bun run test:framework # CLI tests only bun run test:cli # Run burger-api dev server bun run dev
BurgerAPI has two production build modes using the CLI:
burger-api build src/index.ts
.build/bundle/app.jsbun .build/bundle/app.js
burger-api build:exec src/index.ts
.build/executable/<project>.exe.build/executable/<project>--outfile <path> custom output path--target <platform> cross-compile executable target--minify minified output--sourcemap <type> (inline, linked, none) for bundle mode--no-bytecode disable bytecode in executable modeBurgerAPI uses file-based routing. In development, routes are discovered by scanning files at runtime. In production builds, routes are discovered at build time (AOT) so runtime scanning is not needed.
Build flow:
This keeps production startup reliable in bundled and executable outputs.
If you want to contribute, this split helps:
packages/burger-api/src/core/api-router.tspackages/burger-api/src/core/page-router.tspackages/burger-api/src/utils/pathConversion.tspackages/cli/src/utils/scanner.tspackages/cli/src/utils/virtual-entry.tspackages/cli/src/utils/build/pipeline.tspackages/cli/src/utils/build/bun.tspackages/cli/src/utils/build/entry.tsWhen changing route or path conversion logic in either the framework or the CLI, run bun run test:route-sync from the repo root and update the other implementation if the test fails.
packages/burger-api/README.mdpackages/burger-api/PUBLISHING.mdburger-api/
├── packages/
│ ├── burger-api/ # Core framework (published to npm)
│ │ ├── src/ # Source code
│ │ ├── examples/ # Example projects
│ │ └── dist/ # Build output
│ └── cli/ # CLI tool (under development)
│ └── src/ # CLI source code
├── ecosystem/ # Middleware templates (ready-to-use)
├── package.json # Workspace root configuration
└── README.md # This file
We welcome contributions from the community! Whether it's:
Please feel free to open an issue or submit a pull request. Let's build something amazing together!
Contributing Guidelines:
This project is licensed under the MIT License - see the LICENSE file for details.
The MIT License is a permissive license that allows people to do anything with your code as long as they provide attribution back to you and don't hold you liable.
Made with ❤️ for the Bun.js community by Isfhan Ahmed