首页手记打造App-GitHub 开放API大总结

打造App-GitHub 开放API大总结

标签：

Java Android

今天整理了一下GitHub 开放出来API，将它罗列出来，用这些API可获取GitHub上面的数据，返回格式为json，通过使用这些数据，可以用Flutter，ReactNative，Android，iOS等技术开发出这款GitHub客户端练练手，巩固所学知识，岂不是高效率学习一门新技术的手段？

这套API列表主要包含了一下几个方面的内容：

登陆认证信息
All Activity的信息
Trending的信息
个人用户信息
Repos包含的所有信息

下面详细列出每个方面的API，并给出所调用链接及返回的json结果信息。完整的API及返回的结果请查看链接 awesome-github-api

1. 登陆

建议使用OAuth2认证登陆，安全。相关链接：https://developer.github.com/v3/#authentication

2. 关于我的-API

我的页面所涉及到的API，包括：

我的主页
我的关注
我的仓库
我的粉丝

2.1 我的个人主页

2.1.1 请求说明

说明	URL	备注
请求URL	https://api.github.com/user?access_token={token值}
参数	access_token

2.1.2 返回响应

详细json结果请看链接我的个人信息json解析结果

2.2 我的关注 Following

2.2.1 请求说明

说明	URL	备注
请求URL	https://api.github.com/users/{user}/following
参数1	page	int类型
参数2	user	某个用户
例如	https://api.github.com/users/crazyandcoder/following?page=1	需要分页处理

2.2.2 返回响应

备注：结果返回一个数组

详细json结果请看链接我的个人信息json解析结果

2.3 我的粉丝 Followers

2.3.1 请求说明

说明	URL	备注
请求URL	https://api.github.com/users/{user}/followers?page=1	支持分页
参数1	page	int类型
参数2	user	我的用户loginName
例如	https://api.github.com/users/crazyandcoder/followers?page=1	需要分页处理

2.3.2 返回响应

详细json结果请看链接我的个人信息json解析结果

2.4 我的仓库 Repositories

2.4.1 请求说明

说明	URL	备注
请求URL	https://api.github.com/user/repos?affiliation=owner&direction=asc&page=1&sort=full_name&visibility=all
参数1	affiliation	隶属关系，固定值owner
参数2	direction	排序方式，asc升序，desc降序
参数3	page	分页
参数4		sort
参数5	visibility

2.4.2 返回响应

详细json结果请看链接我的个人信息json解析结果

3. 关于All activity-API

All activity所涉及到的API，包括：

3.1 All activity

3.1.1 请求说明

说明	URL	备注
请求URL	https://api.github.com/users/{user}/received_events?name={}&page=1
参数1	user
参数2	name
参数3	page
demo	https://api.github.com/users/crazyandcoder/received_events?name=crazyandcoder&page=1

3.1.2 返回响应

All-Activity返回的结果json

4. 关于Trending-API

Trending所涉及到的API，包括：

Trending-Repositories
Trending-Developers

4.1 Trending-Repositories

4.1.1 请求说明

说明	URL	备注
请求URL	https://github-trending-api.now.sh/repositories?since={}
参数1	since	参考值有daily-weekly-monthly
demo	https://github-trending-api.now.sh/repositories?since=daily

4.1.2 返回响应

Trending-Repositories返回所有的结果json

4.2 Trending-Developers

4.2.1 请求说明

说明	URL	备注
请求URL	https://github-trending-api.now.sh/developers?since={}
参数1	since	参考值有daily-weekly-monthly
demo	https://github-trending-api.now.sh/developers?since=daily

4.2.2 返回响应

Trending-Developers返回所有的结果json

5. 关于User-Repos-API

User-Repos所涉及到的API，包括：

User 某个用户的信息
Repos 某个用户下某个仓库的信息

5.1 User

查询某个用户的信息

5.1.1 请求说明

说明	URL	备注
请求URL	URL https://api.github.com/users/{user}
参数1	user	用户名
demo	URL https://api.github.com/users/arvidn

5.1.2 返回响应

User-Repos-API结果返回的json

5.2 Repos

查询某个用户下的某个Repos信息

5.2.1 请求说明

说明	URL	备注
请求URL	https://api.github.com/repos/{user}/{repos}
参数1	user	某个用户
参数2	repos	该用户下的某个仓库名
demo	https://api.github.com/repos/xingshaocheng/architect-awesome