chanfana
OpenAPI 3 and 3.1 schema generator and validator for Hono, itty-router and more!
File Explorer
Download Latest Version (.zip)- config.json
- README.md
- changeset-check.yml
- create-pullrequest-prerelease.yml
- publish.yml
- semgrep.yml
- test.yml
- dependabot.yml
- config.mts
- base.md
- d1.md
- defining-endpoints.md
- parameters.md
- request-validation.md
- response-definition.md
- logo-icon.png
- logo-square.png
- logo.png
- _redirects
- advanced-topics-patterns.md
- changelog.md
- cli.md
- core-concepts.md
- error-handling.md
- examples-and-recipes.md
- getting-started.md
- index.md
- introduction.md
- migration-to-chanfana-3.md
- openapi-configuration-customization.md
- router-adapters.md
- troubleshooting-and-faq.md
- sync-template-version.js
- version.sh
- SKILL.md
- hono.ts
- ittyRouter.ts
- base.ts
- create.ts
- delete.ts
- list.ts
- read.ts
- update.ts
- create.ts
- delete.ts
- list.ts
- read.ts
- types.ts
- update.ts
- registry.ts
- cli.ts
- contentTypes.ts
- exceptions.ts
- index.ts
- openapi.ts
- parameters.ts
- route.ts
- types.ts
- ui.ts
- utils.ts
- 0001_create_tasks.sql
- hello.ts
- taskCreate.ts
- taskDelete.ts
- taskList.ts
- taskRead.ts
- taskUpdate.ts
- task.ts
- index.ts
- tasks.test.ts
- AGENTS.md
- package-lock.json
- package.json
- README.md
- tsconfig.json
- vitest.config.mts
- wrangler.jsonc
- coverage-gaps.test.ts
- d1-base.test.ts
- d1-endpoints.test.ts
- edge-cases.test.ts
- endpoints.test.ts
- exceptions.test.ts
- hono-types.test-d.ts
- nested-routers-hono.test.ts
- nested-routers.test.ts
- openapi-schema.test.ts
- openapi.test.disabled.ts
- parameters.test.ts
- passthroughErrors.test.ts
- router-options.test.ts
- zod.ts
- bindings.d.ts
- index.ts
- router.ts
- tsconfig.json
- utils.ts
- vitest.config.mts
- wrangler.toml
- .editorconfig
- .gitignore
- AGENTS.md
- biome.json
- CHANGELOG.md
- CODEOWNERS
- LICENSE
- llms.txt
- package-lock.json
- package.json
- README.md
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/cloudflare/chanfana
Downloads the entire project code from GitHub to your computer.
cd chanfana
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm create cloudflare@latest -- --template https://github.com/cloudflare/chanfana/tree/main/template
Type this command into your terminal and run it.
npm i chanfana --save
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)