什么是 @octokit/graphql
@octokit/graphql 是一个用于 GitHub GraphQL API 的 JavaScript 客户端，它基于 Octokit 库构建。它可以使用 Promise 或 Async/Await API 风格同步执行请求，并提供了类型定义来帮助在代码中使用 GraphQL 查询。
安装与引入
你可以使用 npm 来安装 @octokit/graphql，通过以下命令进行安装：
--- ------- ----------------
当然，你也可以直接在项目中引入该库：
----- - ------- - - ----------------------------
或者，如果你使用 ES 模块，可以这样引入：
------ - ------- - ---- -------------------
使用方法
使用 @octokit/graphql 进行 GraphQL API 请求的方法非常简单。你只需要传入你的 GitHub Personal Access Token 和你的查询（即字符串），这样就可以发起请求了。
以下是一个简单的示例：
----- ----------- - ----------------------
----- ----- - -
----- -
------ -
-----
-
-
--
-------------- -
-------- -
-------------- ------ ----------------
--
---------------- -- -
--------------------
---在这个示例中，我们使用 viewer 查询来查询当前用户的登录名。首先，我们传入了 Personal Access Token 和查询字符串（即格式化后的查询）。然后，我们执行了 graphql 函数来发起请求。最后，我们打印了响应的结果。
输入变量
有时，我们需要从外部传入变量来执行 GraphQL 查询。在 @octokit/graphql 中也支持这种情况。我们可以在查询字符串中使用占位符来指定输入的变量，然后将变量传递给 graphql 函数。
以下是一个带有输入变量的查询示例：
----- ----------- - ----------------------
----- ------------ - -
----- -------- -------- ------ -------- -
----------------- ------- ----- ------ -
----
---
-----------
---------
---------
-
-
--
--------------------- -
-------- -
-------------- ------ ----------------
--
------ ----------
----- -------------
---------------- -- -
--------------------
---在这个示例中，我们定义了一个查询，用于获取指定 owner 和 repo 的 GitHub 仓库详细信息。我们在查询字符串中使用了 $owner 和 $repo 占位符来指定这两个输入变量。然后，我们使用 graphql 函数来传递 Personal Access Token 和这两个输入变量。
结语
@octokit/graphql 提供了方便易用的方法来与 GitHub GraphQL API 进行通信。使用它，我们可以轻松地查询和操作 GitHub API 提供的数据。希望本篇文章对你有所帮助！
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/96073