{"meta":{"title":"使用 REST API 和 JavaScript 编写脚本","intro":"使用 Octokit.js SDK 编写脚本，以便与 REST API 交互。","product":"REST API","breadcrumbs":[{"href":"/zh/rest","title":"REST API"},{"href":"/zh/rest/guides","title":"指南"},{"href":"/zh/rest/guides/scripting-with-the-rest-api-and-javascript","title":"使用 JavaScript 编写脚本"}],"documentType":"article"},"body":"# 使用 REST API 和 JavaScript 编写脚本\n\n使用 Octokit.js SDK 编写脚本，以便与 REST API 交互。\n\n## 关于 Octokit.js\n\n如果要使用 JavaScript 编写脚本以与 GitHubREST API 交互， GitHub 建议使用 Octokit.js SDK。 Octokit.js 由 GitHub 维护。 SDK 实现了最佳做法，可让你更轻松地通过 JavaScript 与 REST API 进行交互。 Octokit.js 适用于所有新式浏览器、Node.js 和 Deno。 有关 Octokit.js 的详细信息，请参阅 [Octokit.js 自述文件](https://github.com/octokit/octokit.js/#readme)。\n\n## 先决条件\n\n本指南假定你熟悉 JavaScript 和 GitHub REST API。 有关 REST API 的详细信息，请参阅 [REST API 入门](/zh/rest/using-the-rest-api/getting-started-with-the-rest-api)。\n\n必须安装和导入 `octokit`，才能使用 Octokit.js 库。 本指南使用符合 ES6 的导入语句。 有关不同安装和导入方法的详细信息，请参阅 [Octokit.js 自述文件的用法部分](https://github.com/octokit/octokit.js/#usage)。\n\n## 实例化和身份验证\n\n> \\[!WARNING]\n> 将身份验证凭据视为密码。\n>\n> 若要保护凭据安全，可以将凭据存储为机密，并通过 GitHub Actions运行脚本。 有关详细信息，请参阅“[在 GitHub Actions 中使用机密](/zh/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets)”。\n\n> 还可以将凭据存储为 Codespaces 密钥，并在 Codespaces 中运行脚本。 有关详细信息，请参阅“[管理 GitHub Codespaces 的账户专属的机密](/zh/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)”。\n\n> 如果这些选项是不可能的，请考虑使用另一个 CLI 服务安全地存储凭据。\n\n### 使用personal access token进行身份验证\n\n如果要使用 GitHub REST API 进行个人使用，可以创建一个 personal access token。 有关创建personal access token的详细信息，请参阅[管理个人访问令牌](/zh/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)。\n\n首先，从 `Octokit` 导入 `octokit`。 然后，在创建 personal access token 的实例时，传入你的 `Octokit`。 在下面的示例中，将 `YOUR-TOKEN` 替换为对 personal access token 的引用。\n\n```javascript copy\nimport { Octokit } from \"octokit\";\n\nconst octokit = new Octokit({ \n  auth: 'YOUR-TOKEN',\n});\n```\n\n### 使用GitHub App进行身份验证\n\n如果要代表组织或其他用户使用 API， GitHub 建议使用 GitHub App。 如果某个终结点可供 GitHub Apps 使用，该终结点的 REST 参考文档会注明需要哪种类型的 GitHub App 令牌。 有关详细信息，请参阅 [注册GitHub应用](/zh/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) 和 [关于使用 GitHub 应用进行身份验证](/zh/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)。\n\n不是从 `Octokit` 导入 `octokit`，而是导入 `App`。 在以下示例中，将 `APP_ID` 替换为对应用 ID 的引用。 将 `PRIVATE_KEY` 替换为对应用私钥的引用。 将 `INSTALLATION_ID` 替换为要代表其进行身份验证的应用的安装 ID。 可以在应用的设置页面上找到应用的 ID 并生成私钥。 有关详细信息，请参阅“[管理GitHub应用的私钥](/zh/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)”。 可以使用 `GET /users/{username}/installation`、`GET /repos/{owner}/{repo}/installation` 或 `GET /orgs/{org}/installation` 终结点获取安装 ID。 有关详细信息，请参阅 [GitHub Apps 的 REST API 终结点](/zh/rest/apps/apps)。\n\n```javascript copy\nimport { App } from \"octokit\";\n\nconst app = new App({\n  appId: APP_ID,\n  privateKey: PRIVATE_KEY,\n});\n\nconst octokit = await app.getInstallationOctokit(INSTALLATION_ID);\n```\n\n### 在 GitHub Actions 中进行身份验证\n\n如果要在工作流中使用 GitHub Actions API， GitHub 建议使用内置 `GITHUB_TOKEN` 身份验证，而不是创建令牌。 可以使用 `GITHUB_TOKEN` 密钥向 `permissions` 授予权限。 有关 `GITHUB_TOKEN` 的详细信息，请参阅 [GITHUB\\_TOKEN](/zh/actions/concepts/security/github_token)。\n\n如果工作流需要访问工作流存储库之外的资源，则无法使用 `GITHUB_TOKEN`。 在这种情况下，请将凭据存储为机密，并将以下示例中的 `GITHUB_TOKEN` 替换为机密的名称。 有关机密的详细信息，请参阅 [在 GitHub Actions 中使用机密](/zh/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets)。\n\n如果使用 `run` 关键字在工作流中 GitHub Actions 执行 JavaScript 脚本，则可以将该值 `GITHUB_TOKEN` 存储为环境变量。 脚本可以作为 `process.env.VARIABLE_NAME` 访问环境变量。\n\n例如，此工作流步骤将 `GITHUB_TOKEN` 存储在名为 `TOKEN` 的环境变量中：\n\n```yaml\n- name: Run script\n  env:\n    TOKEN: ${{ secrets.GITHUB_TOKEN }}\n  run: |\n    node .github/actions-scripts/use-the-api.mjs\n```\n\n工作流运行的脚本使用 `process.env.TOKEN` 进行身份验证：\n\n```javascript copy\nimport { Octokit } from \"octokit\";\n\nconst octokit = new Octokit({ \n  auth: process.env.TOKEN,\n});\n```\n\n### 无需身份验证即可实例化\n\n可以在不进行身份验证的情况下使用 REST API，但速率限制较低，并且无法使用某些终结点。 若要创建不进行身份验证的 `Octokit` 实例，请不要传递 `auth` 参数。\n\n```javascript copy\nimport { Octokit } from \"octokit\";\n\nconst octokit = new Octokit({ );\n```\n\n## 发出请求\n\nOctokit 支持多种请求方式。 如果知道终结点的 HTTP 谓词和路径，则可以使用 `request` 方法发出请求。 如果要利用 IDE 中的自动完成和键入功能，可以使用 `rest` 方法。 对于分页终结点，可以使用 `paginate` 方法来请求多页数据。\n\n### 使用 `request` 方法发出请求\n\n若要使用 `request` 方法发出请求，请将 HTTP 方法和路径作为第一个参数传递。 将对象中的任何主体、查询或路径参数作为第二个参数传递。 例如，向 `GET` 发出 `/repos/{owner}/{repo}/issues` 请求并传递 `owner`、`repo` 和 `per_page` 参数：\n\n```javascript copy\nawait octokit.request(\"GET /repos/{owner}/{repo}/issues\", {\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 2\n});\n```\n\n`request` 方法会自动传递 `Accept: application/vnd.github+json` 标头。 若要传递其他标头或不同的 `Accept` 标头，请将 `headers` 属性添加到作为第二个参数传递的对象。\n`headers` 属性的值是将标头名称作为键并将标头值作为值的对象。 例如，发送值为 `content-type` 的 `text/plain` 标头和值为 `x-github-api-version` 的 `2026-03-10` 标头：\n\n```javascript copy\nawait octokit.request(\"POST /markdown/raw\", {\n  text: \"Hello **world**\",\n  headers: {\n    \"content-type\": \"text/plain\",\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n});\n```\n\n### 使用 `rest` 接口方法发出请求\n\n每个 REST API 终结点在 Octokit 中都有一个关联的 `rest` 终结点方法。 为方便起见，这些方法通常会在 IDE 中自动完成。 可以将任何参数作为对象传递给该方法。\n\n```javascript copy\nawait octokit.rest.issues.listForRepo({\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 2\n});\n```\n\n此外，如果使用类型化语言（如 TypeScript），则可以导入用于这些方法的类型。 有关详细信息，请参阅 [plugin-rest-endpoint-methods.js 自述文件中的 TypeScript 部分](https://github.com/octokit/plugin-rest-endpoint-methods.js/#typescript)。\n\n### 发出分页请求\n\n如果终结点已分页，并且你想要提取多页结果，则可以使用 `paginate` 方法。\n`paginate` 将提取下一个结果页到最后一页的结果，然后将所有结果作为单个数组返回。 一些终结点将分页结果作为对象中的数组返回，而不是以数组的形式返回分页结果。\n`paginate` 始终返回项的数组，即使原始结果为一个对象。\n\n例如，以下示例从 `github/docs` 存储库中获取所有问题。 虽然它一次请求 100 个问题，但函数在到达最后一页数据之前不会返回。\n\n```javascript copy\nconst issueData = await octokit.paginate(\"GET /repos/{owner}/{repo}/issues\", {\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 100,\n  headers: {\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n});\n```\n\n`paginate` 方法接受可选的 map 函数，可用于仅从响应中收集所需的数据。 这将减少脚本的内存使用量。 map 函数可以采用第二个参数 `done`，可以调用该参数在到达最后一页之前结束分页。 这样，便可以提取页面的子集。 例如，以下示例继续提取结果，直到返回标题中包含“test”的问题。 对于返回的数据页面，仅存储问题标题和作者。\n\n```javascript copy\nconst issueData = await octokit.paginate(\"GET /repos/{owner}/{repo}/issues\", {\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 100,\n  headers: {\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n},\n    (response, done) => response.data.map((issue) => {\n    if (issue.title.includes(\"test\")) {\n      done()\n    }\n    return ({title: issue.title, author: issue.user.login})\n  })\n);\n```\n\n可以使用 `octokit.paginate.iterator()` 一次循环访问一个页面，而不是一次提取所有结果。 例如，以下示例一次提取一页结果，并在提取下一页之前处理页面中的每个对象。 到达标题中包含“test”的问题后，脚本将停止迭代，并返回已处理的每个对象的问题标题和问题作者。 迭代器是提取分页数据的内存效率最高的方法。\n\n```javascript copy\nconst iterator = octokit.paginate.iterator(\"GET /repos/{owner}/{repo}/issues\", {\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 100,\n  headers: {\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n});\n\nlet issueData = []\nlet breakLoop = false\nfor await (const {data} of iterator) {\n  if (breakLoop) break\n  for (const issue of data) {\n    if (issue.title.includes(\"test\")) {\n      breakLoop = true\n      break\n    } else {\n      issueData = [...issueData, {title: issue.title, author: issue.user.login}];\n    }\n  }\n}\n```\n\n也可以将 `paginate` 方法与 `rest` 终结点方法一起使用。 将 `rest` 终结点方法作为第一个参数传递。 将任何参数作为第二个参数传递。\n\n```javascript copy\nconst iterator = octokit.paginate.iterator(octokit.rest.issues.listForRepo, {\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 100,\n  headers: {\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n});\n```\n\n有关分页的详细信息，请参阅 [在 REST API 中使用分页](/zh/rest/using-the-rest-api/using-pagination-in-the-rest-api)。\n\n## 捕获错误\n\n### 捕获所有错误\n\n有时， GitHub REST API 将返回错误。 例如，如果访问令牌已过期或省略了必需的参数，则会收到错误。 Octokit .js 在收到除 `400 Bad Request`、`401 Unauthorized`、`403 Forbidden`、`404 Not Found` 和 `422 Unprocessable Entity` 以外的错误时，会自动重试请求。 如果在重试后仍发生 API 错误，Octokit.js 会引发一个错误，其中包含响应的 HTTP 状态代码 (`response.status`) 和响应标头 (`response.headers`)。 应在代码中处理这些错误。 例如，可以使用 try/catch 块来捕获错误：\n\n```javascript copy\nlet filesChanged = []\n\ntry {\n  const iterator = octokit.paginate.iterator(\"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\", {\n    owner: \"github\",\n    repo: \"docs\",\n    pull_number: 22809,\n    per_page: 100,\n    headers: {\n      \"x-github-api-version\": \"2026-03-10\",\n    },\n  });\n\n  for await (const {data} of iterator) {\n    filesChanged = [...filesChanged, ...data.map(fileData => fileData.filename)];\n  }\n} catch (error) {\n  if (error.response) {\n    console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)\n  }\n  console.error(error)\n}\n```\n\n### 处理预期的错误代码\n\n有时， GitHub 使用 4xx 状态代码来指示非错误响应。 如果您正在使用的终结点这样做，则可以为特定错误添加额外的处理措施。 例如，如果存储库未加星标，则 `GET /user/starred/{owner}/{repo}` 终结点将返回 `404`。 以下示例使用 `404` 响应来指示存储库未加星标；所有其他错误代码都被视为错误。\n\n```javascript copy\ntry {\n  await octokit.request(\"GET /user/starred/{owner}/{repo}\", {\n    owner: \"github\",\n    repo: \"docs\",\n    headers: {\n      \"x-github-api-version\": \"2026-03-10\",\n    },\n  });\n\n  console.log(`The repository is starred by me`);\n\n} catch (error) {\n  if (error.status === 404) {\n    console.log(`The repository is not starred by me`);\n  } else {\n    console.error(`An error occurred while checking if the repository is starred: ${error?.response?.data?.message}`);\n  }\n}\n```\n\n### 处理速率限制错误\n\n如果收到速率限制错误，可能需要在等待后重试请求。 当您受到速率限制时，GitHub 会返回一个 `403 Forbidden` 错误，且 `x-ratelimit-remaining` 响应标头的值将为 `\"0\"`。 响应标头将包含一个 `x-ratelimit-reset` 标头，该标头告知当前速率限制窗口重置的时间（以 UTC 纪元秒为单位）。 可以在 `x-ratelimit-reset` 指定的时间后重试请求。\n\n```javascript copy\nasync function requestRetry(route, parameters) {\n  try {\n    const response = await octokit.request(route, parameters);\n    return response\n  } catch (error) {\n    if (error.response && error.status === 403 && error.response.headers['x-ratelimit-remaining'] === '0') {\n      const resetTimeEpochSeconds = error.response.headers['x-ratelimit-reset'];\n      const currentTimeEpochSeconds = Math.floor(Date.now() / 1000);\n      const secondsToWait = resetTimeEpochSeconds - currentTimeEpochSeconds;\n      console.log(`You have exceeded your rate limit. Retrying in ${secondsToWait} seconds.`);\n      setTimeout(requestRetry, secondsToWait * 1000, route, parameters);\n    } else {\n      console.error(error);\n    }\n  }\n}\n\nconst response = await requestRetry(\"GET /repos/{owner}/{repo}/issues\", {\n    owner: \"github\",\n    repo: \"docs\",\n    per_page: 2\n  })\n```\n\n## 利用响应功能\n\n`request` 方法返回一个承诺，如果请求成功，该承诺将解析为对象。 对象属性包括 `data`（终结点返回的响应正文）、`status`（HTTP 响应代码）、`url`（请求的 URL）和 `headers`（包含响应标头的对象）。 除非另外指定，否则响应正文会采用 JSON 格式。 某些终结点不返回响应正文；在这些情况下，将省略 `data` 属性。\n\n```javascript copy\nconst response = await octokit.request(\"GET /repos/{owner}/{repo}/issues/{issue_number}\", {\n  owner: \"github\",\n  repo: \"docs\",\n  issue_number: 11901,\n  headers: {\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n});\n\nconsole.log(`The status of the response is: ${response.status}`)\nconsole.log(`The request URL was: ${response.url}`)\nconsole.log(`The x-ratelimit-remaining response header is: ${response.headers[\"x-ratelimit-remaining\"]}`)\nconsole.log(`The issue title is: ${response.data.title}`)\n```\n\n同样，`paginate` 方法返回一个承诺。 如果请求成功，承诺将解析为终结点返回的数据数组。 与 `request` 方法不同，`paginate` 方法不返回状态代码、URL 或标头。\n\n```javascript copy\nconst data = await octokit.paginate(\"GET /repos/{owner}/{repo}/issues\", {\n  owner: \"github\",\n  repo: \"docs\",\n  per_page: 100,\n  headers: {\n    \"x-github-api-version\": \"2026-03-10\",\n  },\n});\n\nconsole.log(`${data.length} issues were returned`)\nconsole.log(`The title of the first issue is: ${data[0].title}`)\n```\n\n## 示例脚本\n\n下面是使用 Octokit.js 的完整示例脚本。 该脚本导入 `Octokit` 并创建新的 `Octokit` 实例。 如果您想使用 GitHub App 而不是 personal access token 进行身份验证，则应导入并实例化 `App`，而不是 `Octokit`。 有关详细信息，请参阅[使用 GitHub App 进行身份验证](#authenticating-with-a-github-app)。\n\n`getChangedFiles` 函数获取为拉取请求更改的所有文件。\n`commentIfDataFilesChanged` 函数调用 `getChangedFiles` 函数。 如果拉取请求更改的任何文件的文件路径中包含 `/data/`，则该函数将对拉取请求进行注释。\n\n```javascript copy\nimport { Octokit } from \"octokit\";\n\nconst octokit = new Octokit({ \n  auth: 'YOUR-TOKEN',\n});\n\nasync function getChangedFiles({owner, repo, pullNumber}) {\n  let filesChanged = []\n\n  try {\n    const iterator = octokit.paginate.iterator(\"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\", {\n      owner: owner,\n      repo: repo,\n      pull_number: pullNumber,\n      per_page: 100,\n      headers: {\n        \"x-github-api-version\": \"2026-03-10\",\n      },\n    });\n\n    for await (const {data} of iterator) {\n      filesChanged = [...filesChanged, ...data.map(fileData => fileData.filename)];\n    }\n  } catch (error) {\n    if (error.response) {\n      console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)\n    }\n    console.error(error)\n  }\n\n  return filesChanged\n}\n\nasync function commentIfDataFilesChanged({owner, repo, pullNumber}) {\n  const changedFiles = await getChangedFiles({owner, repo, pullNumber});\n\n  const filePathRegex = new RegExp(/\\/data\\//, \"i\");\n  if (!changedFiles.some(fileName => filePathRegex.test(fileName))) {\n    return;\n  }\n\n  try {\n    const {data: comment} = await octokit.request(\"POST /repos/{owner}/{repo}/issues/{issue_number}/comments\", {\n      owner: owner,\n      repo: repo,\n      issue_number: pullNumber,\n      body: `It looks like you changed a data file. These files are auto-generated. \\n\\nYou must revert any changes to data files before your pull request will be reviewed.`,\n      headers: {\n        \"x-github-api-version\": \"2026-03-10\",\n      },\n    });\n\n    return comment.html_url;\n  } catch (error) {\n    if (error.response) {\n      console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)\n    }\n    console.error(error)\n  }\n}\n\nawait commentIfDataFilesChanged({owner: \"github\", repo: \"docs\", pullNumber: 191});\n```\n\n## 后续步骤\n\n* 若要详细了解 Octokit.js，请参阅 [Octokit.js 文档](https://github.com/octokit/octokit.js/#readme)。\n* 对于一些现实生活中的示例，请查看 Docs 如何 GitHub 通过 [搜索 GitHub Docs 存储库](https://github.com/search?q=repo%3Agithub%2Fdocs%20path%3A.github%20octokit\\&type=code)来使用 Octokit.js。"}