在前端开发中，访问第三方 API 是非常常见的事情。GitHub 提供了 GraphQL API，可以使我们更灵活地获取我们需要的数据。在本文中，我将介绍一个 npm 包叫做 github-graphql-client，它可以帮助我们快速地访问 GitHub 的 GraphQL API。
安装
首先，我们需要使用 npm 安装 github-graphql-client 包。打开命令行界面，进入你的项目目录，输入如下命令：
npm install github-graphql-client
安装完成后，我们就可以开始使用这个库了。
使用
基本用法
以下是一个简单的使用示例，它获取 GitHub 用户 "octocat" 的信息。
-- -------------------- ---- -------
----- - ------------ - - ---------------------------------
----- ------ - --- ---------------
----- ----- - --
----------- ---------- -
----
-----
---------
-
---
-------------------
---------- -- ------------------
------------ -- ----------------------我们首先导入 GitHubClient，然后创建一个新的客户端对象。我们定义了一个 GraphQL 查询，在查询中获取用户的姓名、电子邮件和头像 URL。最后，我们通过客户端对象调用 query() 方法，该方法将查询作为参数传递，查询结果将返回给我们。
身份验证
如果您需要访问需要身份验证的数据，例如私人存储库或组织，您需要在查询中提供访问令牌。您可以在 GitHub 上生成访问令牌，并使用以下方式提供令牌：
-- -------------------- ---- -------
----- - ------------ - - ---------------------------------
----- ------ - --- --------------
------ -------------------
---
----- ----- - --
------ -
-----
-
---
-------------------
---------- -- ------------------
------------ -- ----------------------我们在创建 GitHubClient 时，提供了访问令牌。我们定义了一个简单的查询，该查询返回当前登录用户的用户名。这个查询需要身份验证，因此我们需要提供一个有效的访问令牌。
高级用法
github-graphql-client 类型定义支持 ES6 模板字面值，允许我们轻松地使用变量和模板字符串来构建查询。以下是一个使用模板字符串构建查询的示例：
-- -------------------- ---- -------
----- - ------------ - - ---------------------------------
----- ------ - --- ---------------
----- ---- - - ------ --------- --
----- ----- - -
----- ------------ -------- -
----------- ------- -
----
-----
---------
-
-
--
------------------- -----
---------- -- ------------------
------------ -- ----------------------在这个示例中，我们定义了一个包含查询变量的查询字符串。我们使用 client.query(query, vars) 方法来传递查询和查询变量。vars 对象指定了 login 变量的值，这个变量在查询中使用。
结论
github-graphql-client 是一个非常方便的 npm 包，它让我们可以快速地访问 GitHub GraphQL API。在本文中，我们学习了如何使用这个包来发出基本和高级查询，以及如何使用访问令牌进行身份验证。我希望这篇文章对您有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055bb581e8991b448d94ea