/add-api-route

Create new API endpoints in your Cloudflare Workers application.

Overview

The /add-api-route command creates RESTful API endpoints using the Hono framework, optimized for Cloudflare Workers edge runtime.

Usage

/add-api-route "Route description"

Examples

# User management endpoint
/add-api-route "GET /api/users - List all users with pagination"

# Data processing endpoint
/add-api-route "POST /api/process - Process uploaded CSV files"

# WebSocket endpoint
/add-api-route "WebSocket /api/ws/chat - Real-time chat connection"

What Gets Created

1. Route Handler - src/routes/[endpoint].ts
2. Middleware - Authentication, validation, rate limiting
3. Type Definitions - Request/response types
4. Tests - Unit tests for the endpoint
5. Documentation - OpenAPI spec updates

Example Implementation

// src/routes/users.ts
import { Hono } from 'hono';
import { z } from 'zod';
import { zValidator } from '@hono/zod-validator';

const app = new Hono();

const querySchema = z.object({
  page: z.string().optional().default('1'),
  limit: z.string().optional().default('10'),
});

app.get('/api/users', 
  zValidator('query', querySchema),
  async (c) => {
    const { page, limit } = c.req.valid('query');
    
    // Fetch from D1 database
    const users = await c.env.DB.prepare(
      'SELECT * FROM users LIMIT ? OFFSET ?'
    ).bind(limit, (page - 1) * limit).all();
    
    return c.json({
      users: users.results,
      pagination: {
        page: parseInt(page),
        limit: parseInt(limit),
        total: users.meta.total
      }
    });
  }
);

export default app;

Best Practices

• Use proper HTTP methods (GET, POST, PUT, DELETE)
• Implement request validation with Zod
• Add authentication middleware where needed
• Return consistent error responses
• Use KV for caching when appropriate

See Also

• Hono Documentation
• Cloudflare Workers
• Add Middleware