介绍
npm 是一个包管理工具，它可以让你方便的安装和维护许多不同的 JavaScript 库。其中，@kgryte/github-get 是一个用于获取 Github 内容的 npm 包，它可以使用 Github 的 API 获取任何公共或私有仓库的信息，包括获取仓库的目录结构、文件内容和历史版本等。
本文将介绍如何使用 @kgryte/github-get 包从 Github 中获取数据，涉及到的主要主题包括：
- 安装和配置 @kgryte/github-get;
- 获取 Github 仓库的目录结构;
- 获取文件的内容以及历史版本。
安装和配置
在开始使用 @kgryte/github-get 之前，需要确保已经注册 Github 账户并且创建了 API token。在首页右上角点击头像，进入 Settings > Developer settings > Personal access tokens 创建 token。创建完成后，复制这个 token 并保存在本地，之后会用到。
安装 @kgryte/github-get：
npm install @kgryte/github-get
使用 Github API 需要进行身份验证，因此在使用 @kgryte/github-get 前，需要设置 Github Token：
const Github = require('@kgryte/github-get');
const github = new Github({
token: 'your_github_token'
});获取 Github 仓库的目录结构
获取 Github 仓库的目录结构，可以使用 github.repos.getContents 方法，此方法接受以下参数：
owner：Github 用户名repo：仓库名称path：指定目录的路径，为空则获取根目录ref：可选参数，提交的引用。
-- -------------------- ---- ------- -- ---------- -------------------------- ------ --------- ----- ------- ------------------ -- - --------------------------- ---------------- -- - ------------------- --- -- ----------- -------------------------- ------ --------- ----- ------- ----- ------ ------------------ -- - --------------------------- ---------------- -- - ------------------- ---
使用 github.repos.getContents 方法获取的是 Github 仓库目录下的所有文件以及子目录，你可以根据规则递归地遍历子目录，获得所有子目录以及文件。此方法返回的数据是 Github API 的响应数据，包含多个属性，常用的有 data 和 headers：
data：返回的数据headers：响应头，包括响应类型、响应时间等信息。
获取文件的内容
获取 Github 仓库中文件的内容，可以使用 github.repos.getContent 方法，此方法接受以下参数：
owner：Github 用户名repo：仓库名称path：文件路径ref：可选参数，提交的引用。
-- -------------------- ---- ------- -- --------- ------------------------- ------ --------- ----- ------- ----- ------------ ------------------ -- - --------------------------- ---------------- -- - ------------------- ---
使用 github.repos.getContent 方法可以获取 Github 仓库中指定文件的内容。此方法返回的数据也是 Github API 的响应数据，包含多个属性，常用的有 data 和 headers。
获取历史版本
如果你想获得文件的历史版本，可以使用 github.repos.getCommits 方法，此方法接受以下参数：
owner：Github 用户名repo：仓库名称path：文件路径sha：可选参数，提交的 SHA 标识符。
-- -------------------- ---- ------- -- ------------- ------------------------- ------ --------- ----- ------- ----- ------------ ------------------ -- - --------------------------- ---------------- -- - ------------------- ---
使用 github.repos.getCommits 方法获得的是 Github 仓库中某个文件的提交记录信息。此方法返回的数据也是 Github API 的响应数据，包含多个属性，常用的有 data 和 headers。
结束语
本文介绍了如何使用 npm 包 @kgryte/github-get 获取 Github 仓库的数据。在获取数据前，我们需要先了解如何注册自己的 Github 账户并生成 token。之后我们使用 @kgryte/github-get 提供的方法获取目录结构、文件内容以及历史版本，如果你需要从 Github 中大量地获取数据，@kgryte/github-get 可以帮助你更轻松地实现这一目标。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bc7967216659e244496