简介
@octokit/plugin-rest-endpoint-methods 是一个 GitHub REST API 的客户端 JavaScript 库。它是 Octokit 的一个插件，提供了多个 GitHub REST API 的端点方法。使用该插件可以轻松的通过 JavaScript 发起 HTTP 请求，并访问 GitHub API。
安装
使用 npm 进行安装：
npm install @octokit/plugin-rest-endpoint-methods
使用方法
使用 @octokit/plugin-rest-endpoint-methods 插件可以通过 API endpoint 发送 HTTP 请求。以下是如何使用它的简单教程：
示例代码
-- -------------------- ---- ------- ----- - ------- - - ------------------------- ----- - ------------------- - - ------------------------------------------------- ----- ------- - --- --------- ----- --------------------- -------- ---------------------- --- ----- -------- - ----- -------------------- ------------------------------------ - ------ ---------- ----- ---------- ----- ------ ---
这里的 octokit.request 函数采用的是最新的 @octokit/request 核心组件，该组件会自动解析 endpoint，发送 HTTP 请求，并提供响应结果。
细节解释
现在，让我们来详细解释代码中的每一行：
const { Octokit } = require("@octokit/core");引入 @octokit/core，这是一个用于在 GitHub API v3 上运行 JavaScript 请求的基本 Octokit。const { restEndpointMethods } = require("@octokit/plugin-rest-endpoint-methods");引入 @octokit/plugin-rest-endpoint-methods，这是一个提供了多个 GitHub REST API 的端点方法的 Octokit 插件。const octokit = new Octokit({ ... })创建一个 Octokit 实例，并添加插件。const response = octokit.request('GET /repos/{owner}/{repo}/contributors', { ... })调用request函数，发送 HTTP 请求，并得到响应结果。
在 response 变量中，你将获得一个包含了接口返回的数据的 Promise。
授权
因为访问 GitHub API 需要授权，所以你需要在每个请求中提供有效的授权令牌，否则你的请求将被拒绝。
你可以通过多种方式来提供令牌：
- 你可以通过
process.env.GH_TOKEN或process.env.GITHUB_TOKEN环境变量来设置令牌。 - 你可以在构造函数中传入令牌：
new Octokit({ auth: 'token YOUR_TOKEN' }); - 你可以为的每个请求单独指定令牌：
octokit.request('GET /repos/{owner}/{repo}/contributors', { headers: { authorization: 'token YOUR_TOKEN' } });
注意，如果你通过环境变量或构造函数提供令牌，则你的所有请求都将使用该令牌，这可能不是一个好的做法，因为某些请求可能不需要该令牌，或需要其他类型的令牌。
结论
这就是 @octokit/plugin-rest-endpoint-methods 的使用教程，它是一个方便、易于使用的库，可以帮助你轻松地访问 GitHub API，而无需过多的编码和调试。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/141988