Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kakengloh/bagel
Tiny and expressive web framework for Bun.js
https://github.com/kakengloh/bagel
bagel https javascript microservice nodejs server typescript web
Last synced: 25 days ago
JSON representation
Tiny and expressive web framework for Bun.js
- Host: GitHub
- URL: https://github.com/kakengloh/bagel
- Owner: kakengloh
- License: mit
- Created: 2022-09-07T15:24:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-12T06:20:18.000Z (almost 2 years ago)
- Last Synced: 2024-09-29T05:21:36.191Z (about 1 month ago)
- Topics: bagel, https, javascript, microservice, nodejs, server, typescript, web
- Language: TypeScript
- Homepage:
- Size: 146 KB
- Stars: 43
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Bagel
**Bagel** is a tiny and expressive web framework for [Bun.js](https://bun.sh/) for building web APIs.
Inspired by [Express.js](https://expressjs.com/) and [Koa.js](https://koajs.com/).
Here we treat **Typescript** as first class citizen, hence every request handler supports **generic** and you may specify your own typing of request params, query, body and response body.
## Contents
- [Features](#features)
- [Examples](#examples)
- [Benchmark](#benchmark)
## Features
✅ Routing
✅ Middlewares
✅ JSON parsing
✅ Strongly typed route handlers
## Installation
```bash
bun add @kakengloh/bagel
```
## Examples
### Basic
```typescript
import { Bagel, Router } from '@kakengloh/bagel';
const app = new Bagel();
app.get('/', async (req, res) => res.send('Hello from Bagel.js!'));
app.listen(3000);
```
### Router
```typescript
import { Bagel, Router } from '@kakengloh/bagel';
// Create items router
const items = new Router();
items.get('/', async (req, res) => res.json({ items: [] }));
// Create v1 router
const v1 = new Router();
// Mount items router to v1 router
v1.mount('/items', items);
const app = new Bagel();
// Mount v1 router to app
app.mount('/v1', v1);
app.listen(3000);
```
### Middleware
```typescript
import { Bagel, Router } from '@kakengloh/bagel';
const app = new Bagel();
// Before middleware
app.use(async (req, res, next) => {
console.log('Before');
});
// Route handler
app.get('/', async (req, res) => res.send('Hello from Bagel.js!'));
// After middleware
app.use(async (req, res, next) => {
console.log('After');
});
app.listen(3000);
```
### Strong typing
```typescript
import { Bagel, Handler } from '@kakengloh/bagel';
// Entity
interface Bread {
bakeryId: string;
name: string;
price: number;
}
// Path parameters
interface PathParams {
bakeryId: string;
}
// Query parameters
type QueryParams = Record;
// Request body
type RequestBody = Bread;
// Response body
interface ResponseBody {
bread: Bread;
}
// Route handler with all types specified
const createBread: Handler<
PathParams,
QueryParams,
RequestBody,
ResponseBody
> = async (req, res) => {
const { name, price } = req.body; // Typed inferred
const { bakeryId } = req.params; // Typed inferred
const bread: Bread = {
bakeryId,
name,
price,
};
return res.json({ bread }); // Typed checked
};
const app = new Bagel();
app.post('/bakeries/:bakeryId/breads', createBread);
app.listen(3000);
```
### Error handling
```typescript
import { Bagel } from '@kakengloh/bagel';
const app = new Bagel({
// Every error thrown will go through this function
// Here you can return a custom response
error: async (res, err) => {
return res.status(400).json({ error: 'Bad request' });
},
});
app.get('/error', async () => {
throw new Error('Some error');
});
app.listen(3000);
```
## Benchmark
Below is a simple benchmark of **Bagel.js** and **Express.js** conducted on my machine using [autocannon](https://github.com/mcollina/autocannon) (12 threads, 500 concurrent connections, 10 seconds)
> The output shows that Bagel.js can handle ~2.67x more requests than Express.js
