ページネーション付き商品一覧のモックレスポンス
合計件数、ページ番号、1ページあたりの件数を含むメタ情報付きのページネーションJSON APIレスポンスを作成。商品カタログのテストに。
REST Responses
詳細な説明
ページネーション付き商品一覧
ページネーションは大規模なコレクションを返すAPIにとって不可欠です。このモックはREST APIで最も広く使用されているオフセットベースのページネーションパターンに従ったページネーション付き商品一覧レスポンスを生成します。
スキーマ構造
{
"data": [
{
"id": "uuid",
"name": "string",
"price": "number",
"currency": "enum(USD,EUR,GBP,JPY)",
"inStock": "boolean",
"category": "enum(electronics,clothing,food,books)"
}
],
"meta": {
"total": 247,
"page": 1,
"perPage": 20,
"totalPages": 13
}
}
ページネーションメタフィールド
| フィールド | 目的 |
|---|---|
total |
全ページの合計レコード数 |
page |
現在のページ番号(1始まり) |
perPage |
1ページあたりのアイテム数 |
totalPages |
計算された合計ページ数(ceil(total / perPage)) |
オフセットベースページネーションの理由
オフセットベースのページネーションは実装と理解が簡単です。クライアントは任意のページに直接ジャンプできます。ただし、大規模データセットでは欠点があり(高オフセットでパフォーマンスが低下)、リクエスト間でデータが変更された場合に一貫性のない結果が生じる可能性があります。リアルタイムデータの場合は、代わりにカーソルベースのページネーションを検討してください。
価格の表現
モックデータではnumber型を価格に使用することは許容されますが、本番環境では浮動小数点精度の問題を避けるために整数セント(例:$19.99に対して1999)またはDecimal型の使用を検討してください。
ユースケース
ECフロントエンドチームが、カタログAPIを待つことなく、ページネーションコントロール、価格フォーマット、在庫表示、カテゴリフィルター付きの商品一覧ページを構築・テストするために使用できます。