octokit.js
功能齊全的 GitHub SDK,適用於瀏覽器、Node.js 和 Deno。
octokit.js 是什麼?
功能齊全的 GitHub SDK,適用於瀏覽器、Node.js 和 Deno。
octokit.js 概覽
這是什麼
octokit.js 是一個全功能的 GitHub SDK,支援瀏覽器、Node.js 和 Deno。它整合了三個主要的 Octokit 函式庫:API 客戶端(REST API 請求、GraphQL API 查詢、認證)、App 客戶端(GitHub App 與安裝、Webhooks、OAuth)以及 Action 客戶端(針對單一儲存庫的預先認證 API 客戶端)。
主要功能
- 完整:涵蓋 GitHub 平台 API 的所有功能。
- 規範:實作所有建議的最佳實踐。
- 通用:可在所有現代瀏覽器、Node.js 和 Deno 中運作。
- 經過測試:所有函式庫都有 100% 的測試覆蓋率。
- 型別化:所有函式庫都有廣泛的 TypeScript 宣告。
- 可分解:只使用你需要的程式碼;你可以在幾行程式碼內建立自己的 Octokit,或使用底層的靜態方法。
- 可擴充:透過外掛程式新增功能、掛鉤到請求或 webhook 生命週期,或實作你自己的認證策略。
使用情境
octokit.js 可用於向 GitHub 的 REST API 發送請求,以及查詢 GitHub 的 GraphQL API。它支援透過靜態令牌、GitHub App 安裝和其他策略進行認證。適合用於建置與 GitHub 互動的應用程式,例如自動化儲存庫管理、處理 webhooks、實作 OAuth 流程,以及建立 GitHub Actions。
快速開始
對於 Node.js,使用 npm/pnpm install octokit 或 yarn add octokit 安裝。import { Octokit, App } from 'octokit';對於瀏覽器,直接從 esm.sh 載入 octokit。<script type="module">import { Octokit, App } from "https://esm.sh/octokit";</script>對於 Deno,直接從 esm.sh 載入 octokit。import { Octokit, App } from "https://esm.sh/octokit?dts";
授權與價格
授權為 MIT。價格類型為開源。
內容整理自該專案公開的 README 與儲存庫資訊。