在前端开发中,我们需要调用多个 API 和第三方服务,而 @octokit/app 就是一款可以帮助我们快速构建 GitHub 应用的 npm 包。本文将介绍 '@octokit/app' 的使用教程,帮助前端开发者快速开发出符合自己需求的 GitHub 应用。
什么是 '@octokit/app'?
'@octokit/app' 是 GitHub 官方提供的一款 npm 包,是在 GitHub 应用开发过程中必要的工具之一。它以 OAuth 用户口令构建出访问 GitHub API 权限的应用程序,并负责传递 JSON Web 令牌。
如何安装 '@octokit/app'?
安装 Node.js
要运行最新版的 '@octokit/app',需要 Node.js v14 或更高版本。
下载地址:https://nodejs.org/
安装 '@octokit/app'
安装 '@octokit/app' 最简单的方法是使用 npm。
npm install @octokit/app
如何使用 '@octokit/app'?
下面是几个 '@octokit/app' 的关键对象和使用指南。
createAppAuth(options)
createAppAuth(options) 是用于创建 OAuth 应用程序的主要函数。
-- -------------------- ---- ------- ------ - ------------- - ---- --------------- ----- ---- - --------------- ------ ----- ----------- ----------- ------- ------------- --------------- ----- --------- --------------------- ------------- ------------------------------------------- ------ -------- ---
选项列表:
id
:应用程序 ID。privateKey
:RSA 私钥,用于签名安装令牌。installationId
:一个整数 ID,表示安装实例。clientId
:OAuth 应用程序的客户端 ID。clientSecret
:OAuth 应用程序的客户端密钥。token
: GitHub 注册表中的 Personal access token。
auth()
auth() 函数是用于做任何向 GitHub REST API 发送请求的核心函数。
const { token } = await auth(); const response = await fetch(url, { headers: { authorization: `token ${token}` }}); const json = await response.json(); return json;
refresh(token)
refresh(token) 函数用于从 Personal access token 获取新的 Personal access token。
const { token } = await auth({ refresh: accessToken });
'@octokit/app' 示例
下面是一个简单的 GitHub 应用程序的示例。
-- -------------------- ---- ------- ------ - ------------- - ---- --------------- ----- -------- ------ - ----- ---- - --------------- ------ ----- ----------- ----------- ------- ------------- --------------- ----- --------- --------------------- ------------- ------------------------------------------- ------ -------- --- ----- - ----- - - ----- ------- ------------------- ----------- ----- -------- - ----- ------------------------------------ - -------- - -------------- ------ --------- ---- ----- ---- - ----- ---------------- -------------------- ----- ---------------- - ---------------------------
通过上面的示例,我们可以看到 '@octokit/app' 的使用方法非常简单。只需要通过 createAppAuth 创建一个 App,然后使用 auth 去请求 API 即可。
总而言之, '@octokit/app' 的学习和使用可以帮助我们快速构建 GitHub 应用。希望本文对你有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/96072