sinnerdys/chanfana-openapi-template

Rising94TypeScriptNo license Last commit 7 months ago

Open on GitHub

Last 24 hours: +121; stars
Last 7 days: +244; stars
Last 30 days: +244; stars
Total stars: 244; 0 a month ago
Forks: 2

Star history

Last 12 weeks · weekly cumulative stars · computed from public GitHub star events

Why it’s rising: #36 in TypeScript this week · +244 stars this week

Rank in its topics

Position among repos ranked in each topic (min. 20 stars gained)

Rank of sinnerdys/chanfana-openapi-template in each topic for today, this week and this month
Topic	Today	This week	This month
TypeScript	#2of 202	#36of 586	#149of 863

Health signals

Too new to assessChecked Oct 17, 2026

Too new to assess: the repository is less than 60 days old or has fewer than 10 commits. The signals below are shown for information only.

Commit activity: Commits in 0 of the last 13 weeks 0 commits on the default branch in 90 days
Maintainers: No commits by people in 90 days
Issue responsiveness: Too few issues to tell 0 issues opened by others in 90 days
Pull requests: None opened in 90 days
Releases: No GitHub releases Not counted: many projects ship without them
Project hygiene: No license, CI or security policy
OpenSSF Scorecard: Not scanned Unknown, not counted against the project

Signals are computed automatically from public GitHub data. They are not an endorsement or a security audit. How health is computed

README

README.md

OpenAPI Template

This is a Cloudflare Worker with OpenAPI 3.1 Auto Generation and Validation using chanfana and Hono.

This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the openapi.json schema automatically from code and validates the incoming request to the defined parameters or request body.

This template includes various endpoints, a D1 database, and integration tests using Vitest as examples. In endpoints, you will find chanfana D1 AutoEndpoints and a normal endpoint to serve as examples for your projects.

Besides being able to see the OpenAPI schema (openapi.json) in the browser, you can also extract the schema locally no hassle by running this command npm run schema.

Important

When using C3 to create this project, select "no" when it asks if you want to deploy. You need to follow this project's setup steps before deploying.

Getting Started

Outside of this repo, you can start a new project with this template using C3 (the create-cloudflare CLI):

npm create cloudflare@latest -- --template=cloudflare/templates/openapi-template

A live public deployment of this template is available at https://openapi-template.templates.workers.dev

Setup Steps

Install the project dependencies with a package manager of your choice:
```
npm install
```
Create a D1 database with the name "openapi-template-db":
```
npx wrangler d1 create openapi-template-db
```
...and update the database_id field in wrangler.json with the new database ID.
Run the following db migration to initialize the database (notice the migrations directory in this project):
```
npx wrangler d1 migrations apply DB --remote
```
Deploy the project!
```
npx wrangler deploy
```
Monitor your worker
```
npx wrangler tail
```

Testing

This template includes integration tests using Vitest. To run the tests locally:

npm run test

Test files are located in the tests/ directory, with examples demonstrating how to test your endpoints and database interactions.

Project structure

Your main router is defined in src/index.ts.
Each endpoint has its own file in src/endpoints/.
Integration tests are located in the tests/ directory.
For more information read the chanfana documentation, Hono documentation, and Vitest documentation.