API 설계 도우미

문서화고급

서비스 요구사항을 입력하면 RESTful API endpoint를 설계하고, 요청/응답 형식, 에러 처리, 인증 방식을 포함한 완성된 API 명세를 생성합니다.

트리거/api [resource]

사용빈도프로젝트 설계 시

기획자가 API 명세를 급하게 요청했을 때라면? /api users로 5분 만에 엔드포인트 + 타입 정의 완성

API설계TypeScript

작동 흐름

/api [리소스] 실행 → 리소스 정의

↓

Phase 1: 4개 생성 병렬

endpoint-gen

CRUD 엔드포인트 생성

type-gen

TypeScript 타입 정의

error-format

에러 응답 포맷

curl-example

curl 예시 생성

↓

✓ API 명세 + TypeScript 타입 + curl 예시

스킬 코드

# 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

복사해서 CLAUDE.md에 붙여넣으면 바로 사용할 수 있습니다.