在 Web 开发中，我们经常需要和 GitHub API 打交道。为了使这种交互更加方便、高效和可靠，我们可以使用 npm 包 express-github。这个包基于 Node.js 和 Express 框架，提供了一组封装好的中间件，帮助我们快速构建 GitHub API 相关的 Web 应用程序。
安装
express-github 是一个 npm 包，可以使用 npm 安装：
npm install express-github
使用
1. 创建 Express 应用程序
首先，我们需要创建一个基于 Express 的 Web 应用程序。可以使用 Express 应用程序生成器，或者手动创建一个 Express 应用程序。
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- --------- --- ---------------- -- -- - ---------------- --------- -- ---- -------- ---
2. 配置 GitHub 身份验证
接下来，我们需要配置 GitHub 的身份验证。GitHub API 支持使用基本身份验证（Basic Authentication）或 OAuth 2.0 身份验证（OAuth 2.0 Authentication）。为了避免安全问题，建议使用 OAuth 2.0 身份验证方式。
-- -------------------- ---- ------- ----- - --------- - - ---------------------- ----- -- - --- ----------- ------ --------------------------- --- -- ----- ----- --- ------------ ----- -- - --- ----------- ----- -------- ------ -------------------------- ---
3. 使用 express-github 中间件
现在，我们可以使用 express-github 中间件了。express-github 提供了一些中间件，可以让我们快速构建 GitHub API 相关的 Web 应用程序。
a. ghMiddleware
const { ghMiddleware } = require("express-github");
app.use(ghMiddleware(gh));这个中间件会将 GitHub API 客户端实例添加到 Express 的 req 对象中，可以通过 req.gh 访问。
app.get("/repos/:owner/:repo", (req, res) => {
const { owner, repo } = req.params;
req.gh.get(`/repos/${owner}/${repo}`).then((response) => {
res.send(response.data);
}).catch((error) => {
res.status(error.response.status).send(error.response.statusText);
});
});b. ghTokenMiddleware
const { ghTokenMiddleware } = require("express-github");
app.use(ghTokenMiddleware("YOUR_GITHUB_ACCESS_TOKEN"));这个中间件会将 GitHub API 客户端实例添加到 Express 的 req 对象中，可以通过 req.gh 访问。
app.get("/repos/:owner/:repo", (req, res) => {
const { owner, repo } = req.params;
req.gh.get(`/repos/${owner}/${repo}`).then((response) => {
res.send(response.data);
}).catch((error) => {
res.status(error.response.status).send(error.response.statusText);
});
});4. 示例代码
下面是一个使用 express-github 的示例应用程序，它实现了 GitHub 的 OAuth 2.0 身份验证，并可以列出授权用户的所有仓库：
-- -------------------- ---- -------
----- ------- - -------------------
----- - --------- - - ----------------------
----- - ------------ - - --------------------------
----- ------- - ---------------------------
----- --- - ----------
----------------- ------- ------------------ ------- ------ ------------------ ----- ----
----- -- - --- -----------
----- --------
------ ---------------------------------
---
--------------------------
------------ ----- ---- -- -
-- --------------------------- -
-----------------------
- ---- -
------------ ------------------ -------------------
-
---
----------------- ----- ---- -- -
----- -------- - ----------------
------------- ------------------------------
------ -------
---
-----------------------
---
----------------- ----- ----- ---- -- -
----- - ---- - - ----------
-- ------ -
--- -
----- - ----- - - ----- ------------------------
------------------------ - ------
------------------
- ----- ------- -
------------------------------------------------------------------
-
- ---- -
----------------------------- -------
-
---
----------------- ----- ----- ---- -- -
--- -
----- -------- - ----- --------------------------
------------------------
- ----- ------- -
------------------------------------------------------------------
-
---
---------------- -- -- -
---------------- --------- -- ---- --------
---结论
使用 express-github 包可以帮助我们快速构建 GitHub API 相关的 Web 应用程序，并且封装了一些有用的中间件，使得编写代码更加简单、高效和可靠。需要注意的是，为了安全起见，我们应该使用 OAuth 2.0 身份验证，并且谨慎处理用户的 GitHub 身份验证信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056ca481e8991b448e60fa