API ページネーション

目次

• 概要
• 使用する場合
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

効率的なクエリ、ナビゲーション、パフォーマンス最適化を備えた大規模データセット処理のためのスケーラブルなページネーション戦略を実装します。

使用する場合

• 大規模なリソースコレクションの返却
• 検索結果のページネーション実装
• 無限スクロールインターフェースの構築
• 大規模データセットクエリの最適化
• クライアントアプリケーションのメモリ管理
• API レスポンス時間の改善

クイックスタート

最小限の動作例:

// Node.js オフセット/リミット実装
app.get('/api/users', async (req, res) => {
  const page = parseInt(req.query.page) || 1;
  const limit = Math.min(parseInt(req.query.limit) || 20, 100); // Max 100
  const offset = (page - 1) * limit;

  try {
    const [users, total] = await Promise.all([
      User.find()
        .skip(offset)
        .limit(limit)
        .select('id email firstName lastName createdAt'),
      User.countDocuments()
    ]);

    const totalPages = Math.ceil(total / limit);

    res.json({
      data: users,
      pagination: {
        page,
        limit,
        total,
        totalPages,
        hasNext: page < totalPages,
// ... (詳細な実装についてはリファレンスガイドを参照)

リファレンスガイド

references/ ディレクトリ内の詳細な実装:

ベストプラクティス

✅ すべきこと

• 大規模データセットにはカーソルページネーションを使用する
• 合理的な最大リミットを設定する (例: 100)
• 可能な場合は合計数を含める
• ナビゲーションリンクを提供する
• ページネーション戦略をドキュメント化する
• ソート用にインデックスされたフィールドを使用する
• 適切な場合はページネーション結果をキャッシュする
• エッジケース (空の結果) を処理する
• 一貫したページネーション形式を実装する
• 非常に大規模なデータセットにはキーセットを使用する

❌ してはいけないこと

• 数十億行のデータでオフセットを使用する
• 無制限のページサイズを許可する
• リクエストごとに行をカウントする
• ソートなしでページネーションする
• ページネーション中にソート順序を変更する
• カーソルなしで深いページネーションを使用する
• 大規模データセットのページネーションをスキップする
• データベースページネーションを直接公開する
• ページネーション戦略を混在させる
• パフォーマンスの影響を無視する