本文旨在指导开发者如何利用 GitHub API 检索用户名中包含特定字符串的用户列表。由于 GitHub API 默认限制每次返回的用户数量，本文将介绍两种分页方法：利用 Octokit 提供的 pagination 功能和手动循环查询，并通过代码示例详细说明如何实现。通过学习本文，您将能够高效地从 GitHub API 获取完整的用户列表，并根据需要进行过滤。
GitHub API 提供了一种强大的方式来检索用户信息，但默认情况下，它会限制每次请求返回的用户数量。为了获取完整的用户列表，特别是当需要搜索用户名包含特定字符串的用户时，我们需要利用分页机制。本文将介绍两种实现分页的方法，帮助您高效地从 GitHub API 获取所需的用户信息。
使用 Octokit 的 Pagination 功能
Octokit 是一个用于与 GitHub API 交互的官方 JavaScript 库，它提供了便捷的 pagination 功能，可以简化分页操作。
以下是使用 Octokit pagination 功能的示例代码：
import { Octokit } from "octokit";
const octokit = new Octokit({
auth: 'YOUR_GITHUB_TOKEN' // 替换为您的 GitHub Token
});
async function listUsers(username) {
const data = await octokit.paginate("GET /search/users", {
q: username, // 使用 search/users API，并指定搜索关键字
per_page: 100, // 每页返回 100 个用户
headers: {
"X-GitHub-Api-Version": "2022-11-28",
},
});
console.log(data);
return data;
}
// 示例：搜索用户名包含 "octocat" 的用户
listUsers("octocat");代码解释：
- import { Octokit } from "octokit";: 导入 Octokit 库。
- const octokit = new Octokit({ auth: 'YOUR_GITHUB_TOKEN' });: 创建 Octokit 实例，并使用您的 GitHub Token 进行身份验证。 请务必替换 YOUR_GITHUB_TOKEN 为您的真实 Token。
-
octokit.paginate("GET /search/users", { ... }): 使用 octokit.paginate 方法进行分页查询。
- "GET /search/users": 指定要调用的 API 接口，这里使用的是 search/users 接口，该接口允许通过关键字搜索用户。
- q: username: q 参数指定了搜索关键字，这里使用传入的 username 参数。
- per_page: 100: 指定每页返回 100 个用户，这是 API 允许的最大值。
- headers: 设置请求头，指定 GitHub API 的版本。
- console.log(data): 打印返回的用户数据。data 是一个包含所有匹配用户的数组。
注意事项：
- 请确保您已经安装了 Octokit 库：npm install octokit
- 为了避免 API 速率限制，建议使用 GitHub Token 进行身份验证。
- search/users API 会根据匹配度进行排序，而不是按照用户 ID 排序。
手动循环查询
如果不想使用 Octokit 的 pagination 功能，也可以手动实现分页查询。
以下是手动循环查询的示例代码：
async function listUsersManually(username) {
let users = [];
let page = 1;
const perPage = 100;
while (true) {
const response = await fetch(`https://api.github.com/search/users?q=${username}&per_page=${perPage}&page=${page}`, {
headers: {
"X-GitHub-Api-Version": "2022-11-28",
"Authorization": `token YOUR_GITHUB_TOKEN` // 替换为您的 GitHub Token
}
});
const data = await response.json();
if (!data.items || data.items.length === 0) {
break; // 没有更多用户，退出循环
}
users = users.concat(data.items);
if (data.items.length < perPage) {
break; // 如果返回的用户数量小于 perPage，说明是最后一页
}
page++;
}
console.log(users);
return users;
}
// 示例：搜索用户名包含 "octocat" 的用户
listUsersManually("octocat");代码解释：
- let users = [];: 初始化一个空数组，用于存储所有匹配的用户。
- let page = 1;: 初始化页码为 1。
- const perPage = 100;: 设置每页返回的用户数量为 100。
- while (true) { ... }: 进入一个无限循环，直到没有更多用户或遇到错误。
-
fetch(...): 使用 fetch API 发送 HTTP 请求。
- https://api.github.com/search/users?q=${username}&per_page=${perPage}&page=${page}: API URL，包含搜索关键字、每页数量和页码。
- headers: 设置请求头，指定 GitHub API 版本和身份验证 Token。 请务必替换 YOUR_GITHUB_TOKEN 为您的真实 Token。
- data = await response.json(): 解析 JSON 响应。
- if (!data.items || data.items.length === 0) { break; }: 检查是否还有更多用户。如果 data.items 为空或长度为 0，则表示没有更多用户，退出循环。
- users = users.concat(data.items);: 将当前页的用户添加到 users 数组中。
- page++;: 增加页码，准备查询下一页。
- if (data.items.length : 如果返回的用户数量小于 perPage，说明是最后一页，退出循环。
注意事项：
- 同样，为了避免 API 速率限制，建议使用 GitHub Token 进行身份验证。
- 需要处理 API 请求可能出现的错误。
- 手动循环查询需要更多代码，但可以更灵活地控制分页过程。
总结
本文介绍了两种使用 GitHub API 列出包含指定字符串的用户的方法：使用 Octokit 的 pagination 功能和手动循环查询。 Octokit 的 pagination 功能更加简洁方便，而手动循环查询则更加灵活。您可以根据自己的需求选择合适的方法。 在使用 GitHub API 时，请务必注意 API 速率限制，并使用 GitHub Token 进行身份验证。 此外，search/users API 是一个强大的工具，可以根据各种条件搜索用户，请查阅 GitHub API 文档了解更多信息。
