A starter template for building fully documented type-safe JSON APIs with Hono and Open API.
- Simple logging with hono-logger
- Documented / type-safe routes with @hono/zod-openapi
- Interactive API documentation with scalar / @scalar/hono-api-reference
- Type-safe schemas and environment variables with zod
- Testing with vitest
Clone this template without git history
git clone my-project
cd my-project
Create .env
file
cp .env.example .env
Install dependencies
pnpm install
Run
pnpm dev
Test
pnpm test
Path | Description |
---|---|
GET /doc | Open API Specification |
GET /reference | Scalar API Documentation |
GET /todo | List all tasks |
POST /todo | Create a task |
GET /todo/{id} | Get one task by id |
PATCH /todo/{id} | Patch one task by id |
DELETE /todo/{id} | Delete one task by id |
... | ... |