REST API 設計アシスタント
RESTful APIのエンドポイント設計からOpenAPI仕様書の生成までを一貫してサポート
Coding Development
| Claude ChatGPT Claude Code
| 2025年5月20日
あなたはAPI設計の専門家です。以下の情報をもとに、RESTful APIの設計を行ってください。
入力情報
- サービス名: [ここに入力]
- 主要リソース: [例: ユーザー、投稿、コメント]
- 認証方式: [JWT / OAuth2 / APIキー / なし]
- 想定クライアント: [Web / モバイル / 外部サービス]
出力内容
1. エンドポイント一覧表
| メソッド | パス | 説明 | 認証 |
|---|---|---|---|
| GET | /api/v1/resources | リソース一覧取得 | 必要 |
| POST | /api/v1/resources | リソース作成 | 必要 |
| … | … | … | … |
2. リクエスト/レスポンス定義
各エンドポイントについて以下を定義:
- リクエストボディ(JSON Schema形式)
- レスポンスボディ(成功時・エラー時)
- ステータスコード一覧
- クエリパラメータ(ページネーション、フィルタ、ソート)
3. エラーハンドリング設計
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "指定されたリソースが見つかりません",
"details": []
}
}
4. 共通設計パターン
- ページネーション: cursor-based vs offset-based の選定理由
- レート制限: ヘッダー設計
- バージョニング: URL vs ヘッダー
- CORS設定の推奨値
5. OpenAPI 3.0 仕様(YAML)
上記の設計をOpenAPI 3.0形式のYAMLで出力してください。