简介
@octokit/auth-app 是一个 Node.js 的 npm 包，旨在让开发者轻松地使用 Octokit 的身份验证功能。本教程将介绍此包的功能及使用方法。
安装与配置
安装
首先，你需要在自己的项目中安装 @octokit/auth-app 包。可以使用 npm 安装命令：
npm install @octokit/auth-app
配置
接下来，你需要在 GitHub 中创建一个 OAuth App 来获取身份验证所需的秘钥信息。具体方法可参见 Creating an OAuth App。
创建完成后，你需要在自己的项目中配置相关的环境变量，具体如下：
process.env.APP_ID = 'your app id'; process.env.CLIENT_ID = 'your client id'; process.env.CLIENT_SECRET = 'your client secret'; process.env.PRIVATE_KEY = 'your private key'; process.env.INSTALLATION_ID = 'your installation id';
其中，APP_ID、CLIENT_ID、CLIENT_SECRET、INSTALLATION_ID 均为从 GitHub OAuth App 中获取到的相应信息。而 PRIVATE_KEY 则需要你在 OAuth App 中生成，获取相应信息。
使用方法
Authenticate 方法
@octokit/auth-app 提供两个主要的方法来实现身份验证：authenticate 和 createToken。其中，authenticate 方法用于验证被授权的应用程序，并创建安装令牌，用于代表应用程序进行 API 请求。其具体用法如下：
const { App, InstallationAccessToken } = require('@octokit/auth-app');
const app = new App({ id: process.env.APP_ID, privateKey: process.env.PRIVATE_KEY });
const installationAccessToken = await app.getInstallationAccessToken({ installationId: process.env.INSTALLATION_ID });
const octokit = new Octokit({ auth: installationAccessToken });上述代码会使用从环境变量中获取的参数初始化一个 Octokit 实例，并使用它进行身份验证。
createToken 方法
createToken 方法用于创建一个访问令牌并进行身份验证。它的具体用法如下：
const { createAppAuth } = require("@octokit/auth-app");
const auth = createAppAuth({ appId: process.env.APP_ID, privateKey: process.env.PRIVATE_KEY, clientId: process.env.CLIENT_ID, clientSecret: process.env.CLIENT_SECRET });
const { token } = await auth({ type: "installation", installationId: process.env.INSTALLATION_ID });
const octokit = new Octokit({ auth: token });上述代码将使用环境变量中的数据初始化一个授权实例（auth），并使用该实例进行身份验证。
示例代码
下面给出一些示例代码，以便更好地说明 @octokit/auth-app 包的使用方法。
-- -------------------- ---- -------
----- - --- - - -----------------------------
----- --- - --- ----- --- ------------------- ----------- ----------------------- ---
----- -------- ------ -
----- ----------------------- - ----- --------------------------------
--------------- ----------------------------
---
----- ------- - --- --------- ----- ----------------------- ---
-- -- --------- ---- ---- -------
-
-------------------- -- -
---------------------
----------------
----- -------------------- ---- ------- ----- - ------------- - - ----------------------------- ----- ---- - --------------- ------ ------------------- ----------- ------------------------ --------- ---------------------- ------------- -------------------------- --- ----- -------- ------ - ----- - ----- - - ----- ------ ----- --------------- --------------- --------------------------- --- ----- ------- - --- --------- ----- ----- --- -- -- --------- ---- ---- ------- - -------------------- -- - --------------------- ---------------- ---
结语
@octokit/auth-app 包提供了便捷的身份验证功能，可帮助开发者更高效地使用 GitHub API。本文提供了该包的安装、配置与使用方法，希望能够帮助读者更好地掌握相关知识。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/114908