文章目錄
- 使用步驟
- 賬号建立
- 進行開發者相關設定
- API操作
- 示範
- Github API好處
- 推薦的Github API
🌟個人首頁: 個人首頁
🚵♀️個人介紹:每天進步一點點，生活變得好一點點。
📌作為一位開發，不管是非工作的還是工作中的人士，或多或少都有和Github接觸。下面我就講一下如何調用Github的api，其中有一些功能還是蠻好的，對于大部分人來說算是福利了。
使用步驟
使用Github API可以遵循以下步驟：
- 建立用于開發測試的賬号
- 注冊Github開發者賬号并申請API Key，以便通路API。
- 閱讀Github API文檔，了解API的功能和限制，并了解如何通路API中的不同資源。
- 建構請求，使用适當的HTTP方法（GET，POST，PATCH等）通路API。請求的格式與資源的類型相關，請參閱文檔以獲得詳細資訊。
- 處理API響應，将傳回的資料解析為所需的格式（例如JSON）。
- 錯誤處理，在API請求失敗時處理錯誤。
賬号建立
如果用于用于開發或者測試，最好别基于原來的賬号去操作，有可能會導緻污染或者資料丢失，甚至可能導緻賬号風險操作。最好去建立一個新賬号。
👉點選跳轉:注冊位址
進行開發者相關設定
大概就幾個步驟:進入開發者設定-> 建立通路token(建立的時候可以根據情況來選擇權限)
上述步驟生成 token
API操作
👉點選跳轉:Github Api 文檔位址
如上圖所示，可以根據版本和需求來點開對應的api文檔，文檔中提供三種方式，按照自己的需求來調用即可。
示範
下面的示例是擷取個人倉庫的Api:
curl -H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer 你的token"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/repos
請求結果
Github API好處
使用Github API可以帶來以下好處：
- 自動化Github任務：使用API可以編寫代碼以自動執行Github任務，例如建立存儲庫，更新存儲庫标簽，合并代碼等。
- 內建Github與其他工具：API可以幫助将Github與其他工具內建在一起，例如使用API提取Github資料以在其他工具中使用。
- 建立Github應用：API可以幫助您建立基于Github的應用程式，以增強Github的功能。
推薦的Github API
- Repositories API：通路存儲庫資訊，例如存儲庫名稱，描述，标簽，送出等。
- Issues API：管理存儲庫問題，例如建立，更新，關閉問題等。
- Pull Requests API：管理存儲庫拉取請求，例如建立，更新，合并等。
- Users API：通路Github使用者資訊，例如使用者名稱，郵件位址，倉庫數量等。
- Organizations API：管理Github組織，例如建立，更新，删除組織等。
這僅是Github API的一小部分，有更多的API可用，請參閱Github API文檔以擷取詳細資訊。