ユーザー一覧APIのモックレスポンス

ユーザー一覧エンドポイント

ユーザー一覧エンドポイントは最も一般的なAPIパターンの一つです。標準的なレスポンスエンベロープでラップされたユーザーオブジェクトの配列を返します。このモックはGET /api/users呼び出しで期待される典型的な構造を示します。

スキーマ構造

{
  "data": [
    {
      "id": "uuid",
      "name": "string",
      "email": "email",
      "role": "enum(admin,user,moderator)",
      "isActive": "boolean",
      "createdAt": "date"
    }
  ]
}

主要な設計判断

• IDにUUID — 連番整数の代わりにUUIDを使用することで、ユーザー総数に関する情報漏洩を防ぎ、分散システムでの衝突問題を回避します。
• enumとしてのRole — ロールを固定値（admin、user、moderator）に制限することで、典型的なRBAC（ロールベースアクセス制御）実装を反映します。
• ISO 8601日付 — createdAtフィールドはISO 8601形式を使用し、JSON APIでの日付シリアライゼーションのデファクトスタンダードです。
• ブーリアンisActive — ソフトデリートやアカウントステータスのためのシンプルなフラグで、レコードを削除せずにアクティブユーザーをフィルタリングするために一般的に使用されます。

ラッパーの選択

{ "data": [...] }ラッパーはリストエンドポイントの推奨パターンです。既存のクライアントを壊すことなく、トップレベルにメタデータ（ページネーション、フィルター）を追加する余地を残すためです。