単一リソース詳細のモックレスポンス

単一リソース詳細

詳細エンドポイントは配列ではなく単一のオブジェクトを返します。GET /api/users/:idやGET /api/products/:idから取得するレスポンスです。レスポンスは配列ラッピングなしのベアオブジェクトです。

スキーマ構造

{
  "id": "uuid",
  "name": "string",
  "email": "email",
  "bio": "string (nullable)",
  "avatarUrl": "url (nullable)",
  "role": "enum(admin,user,moderator)",
  "isVerified": "boolean",
  "lastLoginAt": "date (nullable)",
  "createdAt": "date",
  "updatedAt": "date"
}

Bare vs ラップされたレスポンス

単一リソースエンドポイントでは、多くのAPIがdataラッパーなしで直接オブジェクトを返します。これはシンプルでネストが減ります。ただし、{ "data": {...} }でラップすることも一般的で、リストエンドポイントとの一貫性を提供し、HATEOASパターンの_linksなどのメタデータの余地を残します。

Nullableフィールド

bio、avatarUrl、lastLoginAtフィールドはnullable確率が設定されています。これはUIがオプションデータの欠落をどのように処理するかをテストします。適切に処理されないとランタイムエラーの一般的な原因となります。nullableフィールドには常にフォールバック値または条件付きレンダリングを提供してください。

タイムスタンプフィールド

createdAtとupdatedAtの両方を含めることはベストプラクティスです。「最終更新」表示やIf-Modified-Sinceヘッダーによる条件付きキャッシュを可能にします。