GitHub API 广泛使用在开发过程中，其中 @octokit/rest 提供了更加便捷的方式与 GitHub API 交互。可以使用 Node.js 模块轻松调用 GitHub API，本文将详细介绍如何使用 npm 包 @octokit/rest 进行开发。
安装
使用 npm 包管理工具安装 @octokit/rest：
npm install --save @octokit/rest
身份认证
要与 GitHub API 进行交互，您需要经过身份验证。最简单的方式是将您的个人访问令牌传递给 @octokit/rest。
我建议您创建一个名为 .env 的文件，将个人访问令牌存储在其中，并使用 dotenv 将其加载到 process.env 环境变量中。确保不要将 .env 文件上传到版本控制系统。
// .env 文件 GITHUB_TOKEN=<your_token>
// 加载 .env 文件
require('dotenv').config()创建一个 Octokit 实例
您需要先创建一个 Octokit 实例来调用 GitHub API。在创建实例时，传递身份认证凭据和其他选项。
const { Octokit } = require('@octokit/rest')
const octokit = new Octokit({
auth: process.env.GITHUB_TOKEN, // 身份认证凭据
userAgent: 'my-app', // 可选，自定义 User-Agent
baseUrl: 'https://api.github.com', // 可选，自定义 API 端点 URL
log: console // 可选，自定义日志函数
})调用 API
调用 GitHub API 时，您可以使用已准备好的方法，也可以使用“任意方法”。
已准备好的方法
@octokit/rest 包拥有丰富的已准备好的方法。您可以查看 Octokit API 文档以获取完整列表。
下面以获取 GitHub 用户信息为例，演示使用 octokit.users.getByUsername 方法。
const { data: user } = await octokit.users.getByUsername({
username: 'octokit'
})该方法返回包含用户信息的响应体。使用 async/await 语法处理响应体。
任意方法
@octokit/rest 包中的 octokit.request 方法可以执行任意 HTTP 请求。
下面以获取 GitHub 用户信息为例，演示使用 octokit.request 方法。
const { data: user } = await octokit.request('GET /users/:username', {
username: 'octokit'
})其中，第一个参数表示 HTTP 方法和端点，第二个参数表示请求参数。
错误处理
调用 GitHub API 时可能会出现错误。为了在出现错误时更好地处理它们，您可以使用 @octokit/error 包中的错误。
下面演示一个处理 404 Not Found 错误的例子。
-- -------------------- ---- -------
--- -
----- - ----- ---- - - ----- -----------------------------
--------- --------------
--
- ----- ------- -
-- ------------- --- ---- -
------------------- --- -------
- ---- -
--------------------
-
-示例代码
下面提供一个完整的示例代码，展示如何使用 @octokit/rest 包与 GitHub API 交互。
-- -------------------- ---- -------
--------------------------
----- - ------- - - ------------------------
----- ------- - --- ---------
----- ------------------------
--
----- -------- ----------------- -
--- -
----- - ----- ---- - - ----- -----------------------------
--------
--
------------------ --------------
---------------------- ------------------
- ----- ------- -
-- ------------- --- ---- -
------------------- --- -------
- ---- -
--------------------
-
-
-
------------------总结
上述示例代码演示了如何使用 @octokit/rest 包与 GitHub API 交互。您可以尝试使用其他已准备好的方法或使用任意方法来调用 GitHub API。
身份认证和错误处理是开发中十分重要的话题。在实践中，您应该根据具体情况进行操作，例如可以使用 OAuth2 代替个人访问令牌，也可以将错误记录到日志中。
最后，希望本文能够对您在学习和使用 @octokit/rest 包时有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/89833