介绍
github-api_modified 是一个基于 GitHub API 封装的 npm 包，它提供了在前端应用中非常方便的 GitHub API 访问方式。本篇文章将会介绍如何使用该包以及一些注意事项。
安装
npm install github-api_modified
使用方法
在 Vue.js 中使用 github-api_modified:
-- -------------------- ---- -------
------ --------- ---- ---------------------
----- -- - --- -----------
------ --------------------------
--
-- ---------
---------------------------------------------
-------------- -- -
---------------------
--上述代码中，我们传入了一个 options 对象，其中 token 选项是必须提供的。它是你的 GitHub Access Token，如果你没有这个 Token，请在 GitHub 设置中创建。
在 React 中使用 github-api_modified:
-- -------------------- ---- -------
------ --------- ---- ---------------------
----- --- ------- --------------- -
------------------ -
------------
---------- - -
------------ ----
-
-
------------------- -
----- -- - --- -----------
------ --------------------------
--
---------------------------------------------
-------------- -- -
--------------- ------------ -------- --
--
-
-------- -
-- ------------------------- ------ ---------------------
------ -
-----
--------------------------------------
-------------------------------------------
------
-
-
-在本例中，我们使用 React 的类组件来展示仓库的名称和描述。我们使用了 componentDidMount 生命周期函数来在组件加载完毕后获取仓库信息。
在 Angular 中使用 github-api_modified:
-- -------------------- ---- -------
------ - --------- - ---- ----------------
------ --------- ---- ----------------------
------------
--------- ---------
--------- -
------ ----------------- -------
----- ------------------------ ------
-
--
------ ----- ------------ -
----------- - -----
------------- --
---------- -
----- -- - --- -----------
------ --------------------------
--
---------------------------------------------
-------------- -- -
---------------- - ---------
--
-
-在这个例子中，我们使用 Angular 8 中的组件来获取仓库信息。我们在 ngOnInit 生命周期函数中初始化 GitHub API 并使用它的 getDetails 方法来获取仓库信息。
示例代码
你可以查看示例代码仓库察看更多 github-api_modified 的用法例子: git@github.com:john-smith/github-api_modified-demo.git
提醒
- 你的 Access Token 可以访问你的私有仓库，请不要把 Token 泄露给他人。
- 建议将 Access Token 存储在环境变量中，而不是代码中。
- 如果你需要使用 GitHub API 的时间戳参数，请使用
moment.js等库来处理。 - 如果你需要使用 GitHub API 的分页请求，请参考 GitHub API 文档。
结论
github-api_modified 是一个非常方便的 npm 包，它可以帮助开发者在前端应用中更加方便的使用 GitHub API，而且使用方法非常简单。希望本文可以对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005573681e8991b448d4290