Github API 如何使用?图文讲解 Github API 使用教程

Github API 为开发者提供 REST API 和 GraphQL API 接口。 可以使用 GitHub CLI、curl、官方 Octokit 库和第三方库与这两个 API 进行交互。 有时,某个功能可能受一个 API 支持,但不受另一个 API 支持。Github API 在线地址为:https://github.apifox.cn/,这个在线地址的项目你可以克隆到 Apifox,以方便调试

用 Apifox,节省研发团队的每一分钟

Github API 如何使用?图文讲解 Github API 使用教程

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

Github API 为开发者提供 REST API 和 GraphQL API 接口。 可以使用 GitHub CLI、curl、官方 Octokit 库和第三方库与这两个 API 进行交互。 有时,某个功能可能受一个 API 支持,但不受另一个 API 支持。Github API 在线地址为:https://github.apifox.cn/,这个在线地址的项目你可以克隆到 Apifox,以方便调试(或者你可以访问 Github API 官方文档)。下面将讲解 Github API 的使用,详情见下文。

Github API 使用基本步骤

  1. 创建 Github 开发者账号
  2. 申请 API Key(或者称为 token 凭证),作为访问 Github  API 的凭证。
  3. 构建请求,调试 API,使用适当的 HTTP 方法(GET,POST,PATCH 等)访问 API。

创建 Github 开发者账号

你可以访问 https://github.com/ 来创建一个账号,如果已有,这一步可跳过(具体的注册方式不再赘述)。

创建 Github 账号
创建 Github 账号

获取 Github API Key


注册并登录 Github 后,点击“右上角头像->Settings”,进入用户设置界面。

Github 设置界面
Github 设置界面


然后点击左侧边栏的 “Developer Settings” 选项,配置 Github API Key(即 token)。

Github 开发者选项
Github 开发者选项


Github 支持的验证访问方式有如下几种:使用 token 或者 auth 认证,本文通过 token 的方式来验证。如下图所示,点击左侧边栏的 Tokens,然后开始创建一个 token。

开始创建 Github API Key
开始创建 token


初次设置可能需要你验证,这里可以选择以密码的形式进行安全验证。

进行 Github 安全验证
进行 Github 安全验证


验证完毕,即可设置 token,如下图所示:设置令牌名称(Note)、到期时间(Expiration)、可访问的权限范围(Select scopes),然后保存即可。

设置 token 权限范围
设置 token 权限范围
Github API 的 token 配置成功
token 配置成功

构建 API 请求

有了 token ,就可以最大限度的访问 Github API。

在 Apifox 中发起请求


以下是在 Apifox 中的测试案例,打开 Github API 项目并克隆出来,将刚才生成的 API Key(即 token)复制粘贴到环境变量中,然后点击保存即可。这个 API Key 只保存在本地,其它任何人都无法看到,包括团队成员,也不会同步到 Apifox 的服务器上,所以不用担心安全问题。

Apifox 设置环境变量
Apifox 设置环境变量

在项目中选择一个请求,然后点击“发送”按钮,即可返回相关的响应数据,如下图所示:

Github API 数据响应成功
返回响应数据

通过 Javascript 发起请求

除此之外,你还可以通过代码的方式来发起请求。


Apifox 中,点击“实际请求->JavaScript->Axios”,将代码复制下来,粘贴到编辑器(如 vscode)中运行即可。你也可以选择其它语言,比如 Python、Java、PHP 等,这取决于你的系统是否配置有相关环境。

复制 Apifox 生成的请求代码
复制 Apifox 生成的请求代码


在 vscode 中新建一个 js 文件,然后安装需要的包(npm install axios),然后运行(node xxx.js)即可发起请求,详情如下图所示:

Github API 请求成功,返回响应数据
请求成功,返回响应数据


要请求 Github 的其它 API 也是同样的方法,要使用某个功能,一般是先获取 token 凭证和相关的参数,然后就可以发起请求,并成功返回响应数据。

知识扩展: