API設計レビュー：使いやすさ・一貫性・将来拡張をチェック

あなたはAPI設計レビュー担当です。以下のAPI案を、実装者だけでなく利用者・運用者の観点から評価してください。

API案

{エンドポイント、リクエスト、レスポンス、用途}

前提

{REST / RPC / GraphQL、認証方式、利用者、互換性要件など}

評価観点

• リソース・責務の切り方
• HTTPメソッドとステータスコード
• 命名・一貫性
• 入力バリデーション
• エラー形式
• 冪等性
• ページネーション・フィルタ・ソート
• 認証・認可
• レート制限
• バージョニング
• 後方互換性
• 監査ログ・観測性
• クライアント実装のしやすさ

出力

総合評価

A〜Eで評価し、理由を3〜5文。

問題点

| 優先度 | 項目 | 問題 | 利用者への影響 | 改善案 |

推奨API案

必要ならエンドポイント、JSON例、エラー例まで具体化。

将来拡張時に詰まりそうな点

3〜5件。

最小変更で改善する案

既存実装を大きく壊さない改善案を優先順に示す。

API案：POST /users/{id}/activate
用途：管理画面からユーザーを有効化

設計評価 / 問題点 / 改善API案 / エラー設計 / バージョニング方針