掌握GitHub API用户列表分页：突破100用户限制与数据检索技巧

import { Octokit } from "octokit";

// 初始化Octokit实例
// 生产环境中，请确保以安全的方式管理和使用您的GitHub Personal Access Token
const octokit = new Octokit({ 
  // auth: 'YOUR_GITHUB_TOKEN' // 如果需要访问私有数据或提高速率限制，请提供认证令牌
});

/**
 * 异步函数，用于获取所有GitHub用户
 */
async function getAllGitHubUsers() {
  try {
    console.log("正在通过Octokit的paginate方法获取所有GitHub用户...");

    // 使用paginate方法自动处理分页
    // 它会持续调用GET /users接口，直到所有用户都被获取
    const allUsers = await octokit.paginate("GET /users", {
      per_page: 100, // 每页请求100个用户，这是API允许的最大值
      headers: {
        "X-GitHub-Api-Version": "2022-11-28", // 指定API版本
      },
    });

    console.log(`成功获取到 ${allUsers.length} 个GitHub用户。`);
    // console.log("部分用户数据示例:", allUsers.slice(0, 5)); // 打印前5个用户作为示例
    return allUsers;

  } catch (error) {
    console.error("获取GitHub用户时发生错误:", error);
    throw error; // 重新抛出错误以便上层调用者处理
  }
}

// 调用函数并处理结果
getAllGitHubUsers()
  .then(users => {
    // 可以在此处对获取到的所有用户进行进一步处理
    // 例如，进行客户端过滤
    // console.log("所有用户数据:", users);
  })
  .catch(error => {
    console.error("应用程序级错误:", error);
  });

// MOCK ONLY - 这是一个概念性的示例，需要替换为实际的API请求逻辑
// 例如，使用fetch API或您选择的HTTP客户端

async function getAllGitHubUsersManually() {
  let allUsers = [];
  let lastUserId = 0; // 初始since参数，从ID为0的用户之后开始
  const perPage = 100;
  let hasMoreUsers = true;

  console.log("正在通过手动循环获取所有GitHub用户...");

  while (hasMoreUsers) {
    try {
      // 模拟API请求，实际应用中替换为您的HTTP请求库
      // 例如：await fetch(`https://api.github.com/users?since=${lastUserId}&per_page=${perPage}`, { ... });
      // 这里的query.data.users是模拟的API响应数据
      const response = await fetchGitHubUsersApi(lastUserId, perPage); 
      const currentBatch = response.data.users; // 假设API响应结构

      if (currentBatch && currentBatch.length > 0) {
        allUsers.push(...currentBatch);

        if (currentBatch.length < perPage) {
          // 如果返回的用户数量少于perPage，说明已经到达列表末尾
          hasMoreUsers = false;
        } else {
          // 更新lastUserId为当前批次中最后一个用户的ID，用于下一次请求
          lastUserId = currentBatch[currentBatch.length - 1].id;
        }
      } else {
        // 如果API返回空数组，也表示没有更多用户了
        hasMoreUsers = false;
      }
    } catch (error) {
      console.error("手动分页请求GitHub用户时发生错误:", error);
      hasMoreUsers = false; // 发生错误时停止循环
      throw error;
    }
  }

  console.log(`成功获取到 ${allUsers.length} 个GitHub用户 (手动分页)。`);
  return allUsers;
}

// 这是一个模拟的API请求函数，实际应用中需要替换为真实的HTTP请求
async function fetchGitHubUsersApi(sinceId, perPage) {
  // 在这里实现真实的API调用，例如使用axios或fetch
  // 例如：
  // const response = await fetch(`https://api.github.com/users?since=${sinceId}&per_page=${perPage}`, {
  //   headers: {
  //     'X-GitHub-Api-Version': '2022-11-28',
  //     // 'Authorization': `token YOUR_GITHUB_TOKEN` // 如果需要
  //   }
  // });
  // const data = await response.json();
  // return { data: { users: data } }; // 模拟GitHub API的响应结构

  // 为了示例运行，这里返回模拟数据
  const mockUsers = generateMockUsers(sinceId, perPage);
  return new Promise(resolve => setTimeout(() => resolve({ data: { users: mockUsers } }), 100)); // 模拟网络延迟
}

// 辅助函数：生成模拟用户数据
let globalUserId = 0;
function generateMockUsers(sinceId, count) {
    const users = [];
    let startId = sinceId + 1;
    for (let i = 0; i < count; i++) {
        // 模拟总共只有500个用户
        if (globalUserId >= 500) break; 
        users.push({ id: ++globalUserId, login: `user_${globalUserId}`, type: "User" });
    }
    return users;
}

// 调用函数
// getAllGitHubUsersManually()
//   .then(users => {
//     // console.log("所有用户数据 (手动):", users);
//   })
//   .catch(error => {
//     console.error("手动分页应用程序级错误:", error);
//   });