api-endpoint-builder

Files (1)

• SKILL.md

SKILL.md (first lines)

# API Endpoint Builder

Generate production-ready API endpoints from natural language descriptions using AI.

## Overview

This skill transforms natural language API specifications into complete, type-safe endpoints with:

- **Multiple Frameworks** - Next.js App Router, tRPC, Express
- **Input Validation** - Zod schemas for type-safe validation
- **Authentication** - Built-in auth middleware
- **Error Handling** - Consistent error responses
- **TypeScript** - Full type safety
- **Best Practices** - RESTful design, proper status codes
- **Ready to Deploy** - Production-ready code

## When to Use This Skill

- Building REST APIs for web applications
- Creating tRPC routers for type-safe APIs
- Adding new endpoints to existing APIs
- Learning API design patterns
- Rapid prototyping of backend services

## Quick Start

### Generate Next.js Endpoints

```bash
python3 scripts/generate_endpoints.py "CRUD endpoints for blog posts"
```

### Generate tRPC Router

```bash
python3 scripts/generate_endpoints.py "User management API" --framework trpc
```

### Generate Express Routes

```bash
python3 scripts/generate_endpoints.py "Product catalog endpoints" --framework express
```

## Workflow

### Step 1: Describe Your API

Write a natural language description of the endpoints you need:

**Simple**:
```
"CRUD endpoints for blog posts"
```

**Detailed**:
```
"User management API with:
- List all users (paginated)
- Get user by ID
- Create new user
- Update user profile
- Delete user
- Get user's posts"
```

**Specific Requirements**:
```
"E-commerce product API with:
- List products with filtering (category, price range)
- Search products
- Get product details with reviews
- Add product to cart
- Update cart quantity
- Checkout"
```

### Step 2: Generate Endpoints

Run the generator:

```bash
python3 scripts/generate_endpoints.py "<your description>" [options]
```

**Options**:
- `--framework nextjs` - Next.js App Router (default)
- `--framework trpc` - tRPC router
- `--framework express` - Express.js router
- `--auth` - Include authentication (default: true)
- `--no-auth` - Exclude authentication
- `--validation` - Include Zod validation (default: true)
- `--no-validation` - Exclude validation
- `--output-dir <path>` - Output directory (default: current)

### Step 3: Review Generated Code

The generator creates files with clear structure:

**Next.js**:
```
app/api/posts/route.ts         # List & create
app/api/posts/[id]/route.ts    # Get, update, delete
```

**tRPC**:
```
server/api/routers/posts.ts    # Router with all procedures
```

**Express**:
```
routes/posts.ts                # Router with all routes
```

### Step 4: Integrate into Project

1. Copy generated files to your project
2. Adjust imports and database calls

From hillstreet-ph/open-connect, MIT.

More from hillstreet-ph/open-connect