在现代 Web 开发中，前端配合后端的协同工作越来越紧密，前端也需要通过 API 与后端系统数据进行交互。Octokat 是一个基于 Node.js 的 npm 包，提供了一个轻松使用 GitHub API 的接口。本文将详细介绍如何使用 Octokat 包，以便能更好地去使用 GitHub API 进行开发。
安装
在使用 Octokat 之前，需要先安装 Node.js 以及 npm 包管理器。打开终端并输入以下命令进行安装：
npm install octokat --save
这会将 Octokat 包安装到项目中，并将其添加到 package.json 文件中。--save 参数将其添加到项目的依赖项中。
身份验证
GitHub API 需要身份验证，才能访问私有和公共资源。Octokat 支持不同类型的身份验证，包括：
- 普通用户
- OAuth 应用程序
- OAuth 令牌
- Enterprise 级部署
对于大多数使用情况，可以使用 OAuth 应用程序进行身份验证。OAuth 应用程序使用户可访问他们授权的 GitHub 资源，而无需公开他们的帐户凭据。
在 Octokat 中，身份验证通过使用 API 密钥。以下是如何获取密钥：
- 打开 GitHub 并登录账户。
- 单击右上角的
Settings，然后在左侧面板中单击Developer settings。 - 单击左侧面板中的
Personal access tokens，然后单击右侧的Generate new token。 - 在新页面中创建新的 token，选择所需的范围和权限。将
repo和user选中，以访问用户和库的权限。 - 单击
Generate token以生成 API 密钥。
一些敏感信息，如 API 密钥，不应该在源代码中公开。幸运的是，可以使用环境变量或配置文件来存储此类信息。
以下是一个简单地存储机密信息的配置文件示例：
const config = {
token: 'my-token',
username: 'my-username',
repoName: 'my-repo'
};
module.exports = config;在使用时，可以将配置文件导入到应用程序中，并使用其中的值进行身份验证。
const Config = require('./config');
const Octokat = require('octokat');
const octo = new Octokat({token: Config.token});
const me = octo.users(Config.username).fetch();)基本用法
Octokat 提供了一系列对象，可以轻松管理 GitHub API 资源。以下是一些示例用法：
获取用户信息
const Octokat = require('octokat');
const octo = new Octokat();
const me = octo.users('darylxyx').fetch();
me.then(user => console.log(user.name));
// 输出 “darylxyx”在上面的代码中，使用 API 后缀 fetch() 来发起请求并返回所需数据。
创建 Issue
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - --------------------
----- ---- - --- --------------- ---------------
----- ----- - ----
----------------------- ----------------
----------------
------ ------ - -----
----- ----- ------ - ------- ---- -------
---
------------------- -- ------------------------------
-- -- ----- --在上面的代码中，使用 create() 方法向仓库创建属于 issue。
获取 Issue 详情
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - --------------------
----- ---- - --- --------------- ---------------
----- ----------- - --
----- ----- - ----
----------------------- ----------------
--------------------
---------
---------------- -- -------------------------在上面的代码中，使用 issue 编号使用 issues() API 版本的 Issue 资源，使用 fetch() 请求数据。
获取仓库列表
const Octokat = require('octokat');
const octo = new Octokat();
const repos = octo.users('darylxyx')
.repos.fetch();
repos.then(response => {
response.items.forEach(repo => console.log(repo.name));
});在上面的代码中，使用 fetch() 获取用户的所有仓库，并输出每个仓库的名称。
结论
Octokat 提供了一种使用 API 轻松管理 GitHub 资源的方法，无论您是创建 GitHub 应用程序、构建集成解决方案还是简单地使用 API 执行操作，Octokat 都是您的完美选择。在使用 Octokat 时，需牢记保护机密信息，并使用 API 版本注意事项，如分页和身份验证。了解这些概念后，Octokat 可让您更有效地、更快速地构建 GitHub 集成，并让您专注于创建惊人的产品。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedaf73b5cbfe1ea0611044