Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudflare/chanfana
OpenAPI 3 and 3.1 schema generator and validator for Hono, itty-router and more!
https://github.com/cloudflare/chanfana
api cloudflare cloudflare-workers hono honojs openapi openapi3 router swagger typescript workers workers-script
Last synced: 5 days ago
JSON representation
OpenAPI 3 and 3.1 schema generator and validator for Hono, itty-router and more!
- Host: GitHub
- URL: https://github.com/cloudflare/chanfana
- Owner: cloudflare
- License: mit
- Created: 2022-11-08T11:43:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-08T14:12:33.000Z (14 days ago)
- Last Synced: 2025-01-10T03:04:52.824Z (12 days ago)
- Topics: api, cloudflare, cloudflare-workers, hono, honojs, openapi, openapi3, router, swagger, typescript, workers, workers-script
- Language: TypeScript
- Homepage: https://chanfana.pages.dev
- Size: 3.39 MB
- Stars: 381
- Watchers: 10
- Forks: 43
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
OpenAPI 3 and 3.1 schema generator and validator for Hono, itty-router and more!
**Documentation**: chanfana.pages.dev
**Source Code**: github.com/cloudflare/chanfana
[chanfana](https://github.com/cloudflare/chanfana) **(previously known as itty-router-openapi)** is a library that adds
OpenAPI schema generation and validation to any router (
Hono, itty-router, etc), meant to be a
powerful and lightweight
library for Cloudflare Workers but runs on any runtime supported by the base router.
The key features are:
- OpenAPI 3 and 3.1 schema generator and validator
- Fully written in typescript
- [Class-based endpoints](https://chanfana.pages.dev/user-guide/first-steps/)
- [Query](https://chanfana.pages.dev/user-guide/query-parameters/), [Path](https://chanfana.pages.dev/user-guide/path-parameters/), [Headers](https://chanfana.pages.dev/user-guide/header-parameters/) and [Body](https://chanfana.pages.dev/user-guide/request-body/) typescript inference
- Extend existing [Hono](https://chanfana.pages.dev/routers/hono/), [itty-router](https://chanfana.pages.dev/routers/itty-router/), etc application, without touching old routes
## Getting started
Get started with a template with this command:
```bash
npm create cloudflare@latest -- --type openapi
```
## Installation
```bash
npm i chanfana --save
```
## Minimal Hono Example
```ts
import { fromHono, OpenAPIRoute } from 'chanfana'
import { Hono } from 'hono'
import { z } from 'zod'
export type Env = {
// Example bindings
DB: D1Database
BUCKET: R2Bucket
}
export type AppContext = Context<{ Bindings: Env }>
export class GetPageNumber extends OpenAPIRoute {
schema = {
request: {
params: z.object({
id: z.string().min(2).max(10),
}),
query: z.object({
page: z.number().int().min(0).max(20),
}),
},
}
async handle(c: AppContext) {
const data = await this.getValidatedData()
return c.json({
id: data.params.id,
page: data.query.page,
})
}
}
// Start a Hono app
const app = new Hono()
// Setup OpenAPI registry
const openapi = fromHono(app)
// Register OpenAPI endpoints (this will also register the routes in Hono)
openapi.get('/entry/:id', GetPageNumber)
// Export the Hono app
export default app
```
## Feedback and contributions
[chanfana](https://github.com/cloudflare/chanfana) aims to be at the core of new APIs built using
Workers and define a pattern to allow everyone to
have an OpenAPI-compliant schema without worrying about implementation details or reinventing the wheel.
chanfana is considered stable and production ready and is being used with
the [Radar 2.0 public API](https://developers.cloudflare.com/radar/) and many other Cloudflare products.
You can also talk to us in the [Cloudflare Community](https://community.cloudflare.com/) or
the [Radar Discord Channel](https://discord.com/channels/595317990191398933/1035553707116478495)