Hono OpenAPI Template

• Information: This document is for both humans and AI to understand the project. If you need more details, make a AGENTS.md file. Welcome to your super-cool Hono + OpenAPI starter! 🚀✨

Features

• Hono web framework
• OpenAPI documentation with hono-openapi
• Zod schema validation
• Scalar API docs UI
• Ready for Cloudflare Workers with Wrangler

Getting Started

# Install dependencies
pnpm install

# Run the development server
pnpm dev

# Format code
pnpm format

# Build the project
pnpm build

API Endpoints

Check out /docs. Generated docs are at /docs.

Project Structure

src/
  index.ts      # Main app entry, don't make it messy!
  route.ts      # API routes, make changes here
public/         # Static assets

License

Apache-2.0, see LICENSE for details.

Code Style Guide 🦄✨

To keep our code super neat and sparkly, please follow these rules:

• JavaScript:

  • Avoid. Use TypeScript instead!
  • If you must, follow the same rules as TypeScript.
  • Use JSDoc comments, especially for functions.
  • Do not use common types like Object, Any. Use specific types.

• TypeScript:

  • Name files and folders in kebab-case.
  • Use camelCase for variables and functions, PascalCase for classes and types.
  • Write JSDoc comments as much as possible. Especially, add comments @fires and @listens for event-related functions.

• Hono:

  • MAKE a schema for each endpoint. Check out the route.ts file for examples. It is needed for generating OpenAPI docs.
  • Use middleware for common tasks like authentication, logging, etc.
  • Keep route handlers focused on a single task. We got the serverless power!

• Commit Messages:

  • Use Conventional Commits style. Check out conventionalcommits.org for details.

• Review:

  • PRs should be reviewed by at least one friend(AI friend is friend too) before merging!

Let’s keep everything tidy and readable so everyone can enjoy coding together~! (｡•̀ᴗ-)✧