/scaffold

API Scaffold

Generate route handlers, validation, and types for API endpoints.

Load the nextjs-typescript-engineer and api-design skills for conventions and API patterns.

Usage

/scaffold <resource> [--methods GET,POST,PUT,DELETE] [--auth]

Arguments

Parse $ARGUMENTS to extract:

• resource (required) — Resource name (e.g., users, posts, orders)
• --methods (optional, default: GET,POST,PUT,DELETE) — HTTP methods to generate
• --auth — Add authentication middleware/guards to all endpoints

Instructions

1. Detect Framework

Search the project for:

grep -l "express\|fastify\|koa\|hono" package.json 2>/dev/null       # Node.js
ls app/api/ 2>/dev/null                                                # Next.js App Router
ls pages/api/ 2>/dev/null                                              # Next.js Pages Router
grep -l "flask\|fastapi\|django" requirements.txt 2>/dev/null          # Python
grep -l "gin\|echo\|fiber\|chi" go.mod 2>/dev/null                     # Go
grep -l "laravel\|slim" composer.json 2>/dev/null                      # PHP

2. Detect Existing Patterns

Read 1-2 existing route files to understand:

• File organization (routes/, controllers/, handlers/)
• Naming conventions
• Error handling pattern
• Validation approach (zod, joi, class-validator, etc.)
• Response format (envelope pattern, direct, etc.)
• Database layer (ORM, raw SQL, repository pattern)

3. Generate Route Handlers

For each method, generate appropriate handlers following the project's existing patterns.

Standard REST endpoints:

Method	Route	Handler	Description
GET	/<resource>	list	List all with pagination
GET	/<resource>/:id	get	Get single by ID
POST	/<resource>	create	Create new
PUT	/<resource>/:id	update	Update existing
DELETE	/<resource>/:id	delete	Delete by ID

Each handler should include:

• Input validation (request body, query params, path params)
• Error handling (404, 400, 500)
• Response typing
• Authentication check (if --auth)

4. Generate Types/Interfaces

Create TypeScript interfaces or equivalent for:

• Request body schemas
• Response schemas
• Query parameter types

5. Generate Validation

Using the project's validation library:

• Request body validation schema
• Query parameter validation
• Path parameter validation

6. Present Results

Show all generated files and ask the user before writing. List what was created and any additional setup needed (routes registration, etc.).