npm 包 githubauthquerystring 使用教程

npm 包 githubauthquerystring 使用教程

如果你在使用 GitHub API，你可能已经遇到了需要使用 OAuth2 鉴权标记来进行请求的情况。这个过程可以很繁琐，因为你需要使用这个标记来构造你的请求 URL、Headers 和 Body。但是幸运的是，你可以使用 githubauthquerystring 这个 npm 包，使这个过程变得更易于使用。

安装

首先，你需要安装该 npm 包。你可以使用 npm:

npm install --save githubauthquerystring

或者 yarn:

yarn add githubauthquerystring

使用步骤

1. 导入 GitHubAuth 类

在你的项目代码中导入类:

const { GitHubAuth } = require('githubauthquerystring');

2. 初始化 GitHubAuth 对象

GitHubAuth 类需要两个参数:

• access_token: Access Token 是由 GitHub 颁发的 OAuth2 鉴权标记，必填
• client_id: 客户端 ID，从 your GitHub settings 页面获取，可选

const auth = new GitHubAuth('my-access-token', 'my-client-id');

3. 使用 GitHubAuth 对象构造请求 URL

使用 GitHubAuth.getWithAuth 方法，为包含鉴权标记的 URL 添加查询参数:

const authUrl = auth.getWithAuth('https://api.github.com/user');
console.log(authUrl); // https://api.github.com/user?access_token=my-access-token

4. 使用 GitHubAuth 对象构造请求 Body

使用 GitHubAuth.postWithAuth 方法，为包含鉴权标记的请求 Body 添加参数:

const body = auth.postWithAuth({
  myParameter: 'parameter',
  myArray: [ 'arrayItem1', 'arrayItem2'],
});

console.log(body) // 'myParameter=parameter&myArray%5B0%5D=arrayItem1&myArray%5B1%5D=arrayItem2'

示例代码

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

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

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

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

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

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

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

现在你已经了解了 githubauthquerystring npm 包的使用，它应该可以简化你在使用 GitHub API 过程中的一些任务。

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