API設計ヘルパー
ドキュメント上級
サービス要件を入力するとRESTful APIエンドポイントを設計し、リクエスト/レスポンス形式、エラー処理、認証方式を含む完成されたAPI仕様を生成します。
トリガー
/api [resource]使用頻度設計時
企画者がAPI仕様を急ぎで依頼してきたときなら？ /api usersで5分でエンドポイント + 型定義を完成
API設計TypeScript
動作フロー
/api [リソース] 実行 → リソース定義
↓
フェーズ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に貼り付ければ、すぐに使えます。
API設計ヘルパー の仕組み
API Designerはリソース名を受け取り、エンドポイント、リクエスト/レスポンススキーマ、TypeScript型定義、エラーハンドリングパターン、OpenAPI仕様を含む完全なRESTful API設計を、RESTベストプラクティスに従って生成します。
API設計ヘルパー が力を発揮する場面
新しいマイクロサービスの立ち上げや主要機能の追加時にAPI設計フェーズを大幅に加速します。生成された型とスキーマはフロントエンドとバックエンドチーム双方のドキュメントと実装契約として機能します。
主な強み
- 単一のリソース名から完全なREST API設計を生成
- 実装契約として機能するTypeScript型を含む
- REST ベストプラクティスと命名規約に自動準拠
- ドキュメントツール対応のOpenAPI仕様を出力