如何通过GitHub API高效获取超过100个用户列表（分页教程）

import { Octokit } from "octokit";

// 初始化Octokit实例，如果需要认证，可以在这里传入auth token
const octokit = new Octokit({
  // auth: 'YOUR_GITHUB_TOKEN' // 如果需要访问私有数据或提高速率限制，请提供认证token
});

async function getAllGitHubUsers() {
  try {
    console.log("正在通过octokit.paginate获取所有GitHub用户...");

    // 使用paginate方法获取所有用户
    // per_page 参数指定每页返回的数量，最大为100
    const allUsers = await octokit.paginate("GET /users", {
      per_page: 100, // 每页请求100个用户
      headers: {
        "X-GitHub-Api-Version": "2022-11-28", // 指定API版本
      },
    });

    console.log(`成功获取到 ${allUsers.length} 个GitHub用户。`);
    // console.log(allUsers); // 打印所有用户数据
    return allUsers;

  } catch (error) {
    console.error("获取GitHub用户时发生错误:", error);
    throw error;
  }
}

// 调用函数
getAllGitHubUsers();

// 这是一个模拟实现，用于说明手动分页的逻辑
// 实际生产环境应替换为真实的API请求库（如axios, fetch等）

async function getAllGitHubUsersManually() {
  let allUsers = [];
  let lastUserId = 0; // 初始时从第一个用户开始（ID为0或更小）
  const perPage = 100; // 每页请求数量
  let hasMoreUsers = true;

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

  while (hasMoreUsers) {
    try {
      // 模拟API请求
      // 在实际应用中，这里会是 `await octokit.request('GET /users', { since: lastUserId, per_page: perPage, ... })`
      // 或者 `await fetch(`https://api.github.com/users?since=${lastUserId}&per_page=${perPage}`, { ... })`
      const response = await mockApiRequest(lastUserId, perPage); // 模拟函数
      const currentUsers = response.data.users; // 假设API返回的数据结构

      if (currentUsers && currentUsers.length > 0) {
        allUsers = allUsers.concat(currentUsers);
        // 更新lastUserId为当前批次中最后一个用户的ID
        lastUserId = currentUsers[currentUsers.length - 1].id;

        // 如果返回的用户数量小于perPage，说明已经到达列表末尾
        if (currentUsers.length < perPage) {
          hasMoreUsers = false;
        }
      } else {
        // 如果没有返回用户，也说明已经到达列表末尾
        hasMoreUsers = false;
      }
      console.log(`已获取 ${allUsers.length} 个用户，当前批次 ${currentUsers.length} 个。`);

    } catch (error) {
      console.error("手动获取GitHub用户时发生错误:", error);
      hasMoreUsers = false; // 发生错误时停止循环
      throw error;
    }
  }

  console.log(`手动获取完毕，共 ${allUsers.length} 个GitHub用户。`);
  return allUsers;
}

// 模拟API请求函数 (仅用于演示逻辑)
// 实际应用中需要替换为真实的API调用
async function mockApiRequest(sinceId, perPage) {
  // 假设这是一个模拟的GitHub API响应
  const mockUsers = [];
  for (let i = 1; i <= 500; i++) { // 模拟总共有500个用户
    mockUsers.push({ id: i, login: `user${i}` });
  }

  const startIndex = mockUsers.findIndex(user => user.id > sinceId);
  if (startIndex === -1) {
    return { data: { users: [] } }; // 没有更多用户
  }

  const usersSlice = mockUsers.slice(startIndex, startIndex + perPage);
  return { data: { users: usersSlice } };
}

// 调用函数
getAllGitHubUsersManually();