npm 包 @octokit/auth-oauth-app 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端开发中，我们经常会需要使用到 Github API 来获取一些数据，比如某个用户的仓库列表，代码片段等。然而，在使用 Github API 前，我们需要进行身份认证，这就需要我们用到 OAuth 2.0 协议。

而在 Node.js 开发中，我们可以使用 @octokit/auth-oauth-app 这个 npm 包来进行 Github OAuth 认证。该包是 Github 官方提供的 Octokit 库的一个子库，它封装了 Github OAuth 认证相关的逻辑，可以让我们轻松地完成认证过程。

本篇文章将为大家详细介绍 @octokit/auth-oauth-app 的使用方法，包括身份认证、生成 token、使用 API 等。

安装

在开始使用 @octokit/auth-oauth-app 前，我们需要先安装它。使用 npm 安装即可：

npm install @octokit/auth-oauth-app

身份认证

在使用 Github API 之前，我们需要先进行身份认证。首先，我们需要在 Github 上注册一个 OAuth App，并获取到 client_id 和 client_secret。在注册时需要设置 Authorization callback URL，该 URL 用于 Github 认证后返回到我们的应用程序。

在 Node.js 中，我们可以使用 @octokit/auth-oauth-app 这个包来进行身份认证。在进行身份认证之前，我们需要引入该包并创建一个 createOAuthAppAuth 的实例。

const { createOAuthAppAuth } = require("@octokit/auth-oauth-app");

const auth = createOAuthAppAuth({
  clientId: "xxx",
  clientSecret: "yyy",
});

这里的 clientId 和 clientSecret 即为我们在 Github 上注册 OAuth App 后获取的参数。在创建 auth 实例后，我们可以调用 auth() 方法来进行 OAuth 认证。

const { token } = await auth({ type: "oauth-app" });

在调用 auth() 方法时，我们需要传入 type: "oauth-app" 参数来指示我们使用 OAuth APP 进行认证。调用完成后会返回一个包含 token 的对象，这个 token 就是我们认证后获取到的 Github Access Token。后续的操作都需要使用到该 token。

生成 Token

获取到 Access Token 后，我们需要将其用于后续的 API 调用。我们可以将 token 直接传递给 Github API：

const { Octokit } = require("@octokit/rest");

const octokit = new Octokit({
  auth: token,
});

这里的 token 即为我们在身份认证步骤中获取到的 Access Token，该 token 是我们调用 Github API 的凭证。

使用 API

在获得认证后，我们就可以开始使用 Github API 进行相关的操作。比如，我们可以获取某个用户的公开仓库列表：

const { data: repos } = await octokit.repos.listForUser({
  username: "gzc",
});
console.log(repos);

这里的 octokit.repos.listForUser() 方法即为使用 OAuth 认证请求 Github API 的方法。在我们使用这个方法来获取 Github 用户仓库列表时，Github API 会使用我们在 OAuth App 中注册的 client_id 和 client_secret 来进行认证。

示例代码

下面是一个完整的使用示例代码：

-- -------------------- ---- -------
----- - ------------------ - - -----------------------------------
----- - ------- - - -------------------------

----- ---- - --------------------
  --------- ------
  ------------- ------
---

----- -------- ----- -
  ----- - ----- - - ----- ------ ----- ----------- ---

  ----- ------- - --- ---------
    ----- ------
  ---

  ----- - ----- ----- - - ----- ---------------------------
    --------- ------
  ---

  -------------------
-

------

总结

通过以上步骤，我们就可以在 Node.js 中使用 @octokit/auth-oauth-app 完成 Github OAuth 认证，并使用 Github API 进行操作了。当然，除了 @octokit/auth-oauth-app 这个包，Github 还提供了很多适用于 Node.js 开发的 API ，可以帮助我们完成更多的操作。最后，希望本篇文章能够对大家有所帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/5f31e4353b0ab45f74a8bd27