API Design Assistant

DocumentationAdvanced

Given service requirements, designs RESTful API endpoints and generates complete API specs including request/response formats, error handling, and authentication.

Trigger/api [resource]

FrequencyDuring design

When a PM urgently requests an API spec? Run /api users to get endpoints + type definitions in 5 minutes

APIDesignTypeScript

How It Works

Run /api [resource] -> define resource

↓

Phase 1: 4 generation tasks in parallel

endpoint-gen

Generate CRUD endpoints

type-gen

Define TypeScript types

error-format

Error response format

curl-example

Generate curl examples

↓

✓ API spec + TypeScript types + curl examples

Skill Code

# API Designer Skill
## Trigger: /api [resource name]

When invoked:

1. Define resource:
 - Ask for resource fields and relationships
 - Determine CRUD operations needed

2. Generate endpoint table:
| Method | Endpoint            | Description | Auth |
|--------|---------------------|-------------|------|
| GET    | /api/[resource]     | List all    | ✅   |
| GET    | /api/[resource]/:id | Get one     | ✅   |
| POST   | /api/[resource]     | Create      | ✅   |
| PUT    | /api/[resource]/:id | Update      | ✅   |
| DELETE | /api/[resource]/:id | Delete      | ✅   |

3. Generate TypeScript interfaces:
```typescript
interface Resource {
id: string;
// ... fields
createdAt: string;
updatedAt: string;
}

interface CreateResourceRequest {
// ... required fields
}

interface ResourceListResponse {
data: Resource[];
total: number;
page: number;
}
```

4. Generate error response format
5. Add example curl commands

Copy and paste into your CLAUDE.md to start using immediately.

How API Design Assistant Works

API Designer takes a resource name, generates a complete RESTful API design with endpoints, request/response schemas, TypeScript type definitions, error handling patterns, and OpenAPI specification — following REST best practices.

When to Use API Design Assistant

Speeds up API design phase significantly when starting new microservices or adding major features — the generated types and schemas serve as both documentation and implementation contracts for frontend and backend teams.

Key Strengths

Generates complete REST API design from a single resource name
Includes TypeScript types that serve as implementation contracts
Follows REST best practices and naming conventions automatically
Produces OpenAPI spec ready for documentation tools

Same Category

Documentation View All

Auto Doc Generator

Analyzes code and auto-generates API docs and usage guides.

README Generator

Analyzes your project and auto-generates a polished README.md.

Git History Analyzer

Extracts project insights and contribution patterns from Git history.

Popular in Other Categories

Session Summary

WorkflowAutomatically summarizes changes and next steps at the end of a work session.

Smart Commit

CodingAnalyzes changes and auto-generates meaningful commit messages.

CLAUDE.md Builder

ProductivityAnalyzes your project and auto-generates an optimized CLAUDE.md.