這篇文章將來介紹一下如何使用 API 來讀取 GitHub repository 上的檔案,而為什麼需要這樣做呢?
因為我專精的是 iOS 啊
以一個 iOS 工程師而言,我們若需要自己維護一個 side project(如 找健身),那我們就得想一些簡單一點的 server 方案;其中一個就是可以將一個 JSON 檔案放到 GitHub 的某個私人 repository 上,並透過 GitHub API 的方式去讀取它,達到 GET 的效果。
這樣便可以有效率地開發 iOS 的部分,而不必花太多心思在維護後端,至少不必煩惱伺服器的費用和穩定😂
流程
取得 API Token
首先我們得先到 GitHub 的設定頁之中,去建立一組 API token
選取 Developer settings
選擇 Personal access tokens 並建立一組
再來依據你的需求選擇 scopes,像是 repo 存取全開
接著就會拿到一組 Token!
API 的使用方式
首先我們得在 Headers 加上兩個 KEY-Value
Authorization: token YourAccessToken
Accept: application/vnd.github.v3.raw
而 URL 則是
https://api.github.com/repos/GitHubUserName/RepositoryName/contents/PathOfFile/FileName.json?ref=master
記得改成你的 GitHub user name 以及所對應的 repository 名稱和檔案路徑,而 Params 可以帶入
ref: master
master 可以改成其他 branch 的名稱,這樣便可以讀取到檔案的 raw 了!