在前端开发中，我们经常需要与后端进行数据交互。而使用 API 是实现数据交互的常见方式之一。GitHub 提供了一套丰富的 API，使得前端开发者能够方便地与 GitHub 进行数据交互。而 @octokit/routes 就是一款 GitHub 官方的 API 路由器，可以通过安装和使用它来轻松地与 GitHub 进行交互。
安装
@octokit/routes 是一个 npm 包，可以通过 npm 进行安装。首先需要在项目的根目录中打开终端，执行以下命令进行安装：
--- ------- ---------------
使用
安装成功后，我们就可以在项目中使用 @octokit/routes 了。下面是一个简单示例：
----- - ------- - - -------------------------
----- - ------ - - ---------------------------
----- ------- - --- ---------
----- -----------------------------
---
----- ------ - ----------- -----------------------------
------ -- -- -
----- -------- - ----- ----------------------- -
------ ----------
----- ----------
---
----------------------
-----该示例中，我们首先通过 require 方法引入了 @octokit/rest 和 @octokit/routes 两个模块，并通过 new Octokit() 创建了一个 GitHub 客户端。然后，我们使用 routes 属性获取了一条 GitHub API 的路由（这里是获取某个仓库的 issue），并在请求参数中设置了相应的路由参数，最后通过 octokit.request() 发送请求并处理返回结果。
深入理解
下面我们来详细了解一下 @octokit/routes 的使用。
路由
路由是指在请求中指定的 API 路径。在 @octokit/routes 中，可以通过 routes 属性获取一条或多条 GitHub API 的路由。路由的格式为 {HTTP 请求方法} {API 路径}，例如：
GET /repos/:owner/:repo/issues：获取某个仓库的 issuePOST /orgs/:org/migrations：创建迁移
路由中的 :owner 和 :repo 称为路由参数，可以通过请求参数进行设置。
请求
在 @octokit/routes 中，可以使用 GitHub 官方的 @octokit/rest 模块来发送请求。octokit.request() 方法可以用于发送一次请求，其参数包括请求路由和请求参数。
---------------------- ------------
其中，route 参数为请求路由，可以通过 routes 属性获取；parameters 参数为请求参数，包括路由参数和其他可选参数。例如，在获取某个仓库的 issue 时，可以这样设置请求参数：
----- -------- - ----- ----------------------- - ------ ---------- ----- ---------- ------ ------- ---
这里，owner 和 repo 是路由参数，需要与路由中的名称保持一致；state 是一个可选参数，用于过滤获取的 issue。
返回结果
在使用 octokit.request() 发送请求后，可以通过 Promise 的方式获取返回结果。返回结果是一个 JavaScript 对象，包含了 GitHub API 返回的所有信息。例如，在获取某个仓库的 issue 后，可以这样获取返回结果：
---------------------------
注意，返回结果中可能包含有分页信息，需要通过 Link 头获取。
总结
总体来说，@octokit/routes 是一款非常方便的 API 路由器，能够帮助前端开发者轻松地与 GitHub 进行数据交互。在使用时，需要仔细阅读 API 文档，选择合适的路由和参数进行请求，并合理解析返回结果。希望本篇文章对大家的学习和工作有所帮助！
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/octokit-routes