记录如何使用github.v3来操作仓库
这里只讲如何上传文件到指定仓库指定位置,基于这一点来展开
其他操作类似
用到的工具:Insomnia 官网
用它发送请求很方便
api接口介绍
-
传输方法:
PUT
-
访问路径:
https://api.github.com/repos/用户名/仓库名/contents/文件路径
-
请求头:
Content-Type: application/json X-GitHub-Media-Type: github.v3
说明数据格式是json,显示指定api使用v3(非必须,默认是v3)
-
JSON格式:
{
"message": "commit from INSOMNIA",
"content": "bXkgbmV3IGZpbGUgY29udGVudHM="
}
message:提交的问的说明,content:文件内容的base64格式
message和content都是必须的
其他非必须的还可以指定 提交到的分支(默认master),提交者信息(默认鉴权的提交者)官方文档
鉴权
由于涉及到了,仓库的增加操作,所以需要我们有相应仓库增加文件的操作权限
官方提供了三种方式:
- 通过用户名和密码(Basic authentication)
- 通过token(OAuth2 token)
- 通过应用的
client_id
和client_secret
访问(OAuth2 key/secret),只支持查询操作。
推荐第二种方式(这里我们采用第二种)
- token在请求头里
Content-Type: application/json
X-GitHub-Media-Type: github.v3
Authorization : token xxxxxxxxxfc52593xxxxxxxxxxxx
- token在URL里
https://api.github.com/repos/用户名/仓库名/contents/文件路径?access_token=xxxxxxxxxfc52593xxxxxxxxxxxx
实例
-
打开Insomnia新建请求
<