其实 Github 除了做你的代码库以外,还可以暴露一些信息出来通过接口供你调用。

比如你想要做一个看板,可以实时刷新来查看自己的 Github 项目 star 数/follow 数等等。

首先附上原汁原味的文档:Github REST API

获取信息的 APIs(常用)

这一 part 提及的所有 API 的请求方法都是 GET 方法,返回的数据都是 JSON 格式的。

说明地址备注
获取个人所有 repohttps://api.github.com/users/{用户名}/repos
获取 repo 详细信息https://api.github.com/repos/{用户名}/{仓库名}
获取 repo 内容列表https://api.github.com/repos/{用户名}/{仓库名}/contents只返回根目录内容
获取某个文件的原始档(raw)https://raw.githubusercontent.com/{用户名}/{仓库名}/{分支名}/{文件路径}
repo 中 commit 列表https://api.github.com/repos/{用户名}/{仓库名}/commits
commit 详情https://api.github.com/repos/{用户名}/{仓库名}/commits/{某一条commit的SHA}
repo 中 issue 列表https://api.github.com/repos/{用户名}/{仓库名}/issues
issue 详情https://api.github.com/repos/{用户名}/{仓库名}/issues/{序号}序号为整型:1、2...

查询参数

以上 REST API 都可以通过添加 param 查询参数的形式查询参数

分页

参数数据类型含义备注
pageint页码
per_pageint页长(每页显示数量)
?page={页码}&per_page={页长}

状态

以 issue 来举例

https://api.github.com/repos/{用户名}/{仓库名}/issues?state=closed

CURD

实际上我们可以通过 REST API 进行以上内容的增删查改,详细的操作建议阅读官方文档Github REST API来获取更多信息。