octokit/octokit.js

これは何？

主な機能

• 011つのクライアントからGitHubのREST APIとGraphQL APIを呼び出せます。
• 02トークンやGitHub Apps向けの認証方式を備えています。
• 03リクエストのリトライとレート制限に応じたスロットリングを標準で処理します。
• 04RESTとGraphQLの結果をページネーションするヘルパーを提供します。
• 05Node middlewareを通じてWebhookを受信・検証し、OAuthフローを処理できます。
• 06TypeScriptの型宣言を同梱し、ブラウザー、Node.js、Denoで動作します。

ユースケース

• issue、コメント、プルリクエストを作成するbotや自動化ツールの構築。
• インストール済みリポジトリのWebhookイベントに応答するGitHub Appの開発。
• WebアプリケーションへのGitHub OAuthログインの追加。
• フロントエンドやNode.jsサービスからGraphQLでGitHubのデータを取得。

クイックスタート

1. 1

   npmでoctokitパッケージをインストールする

   npm install octokit
2. 2

   Octokitをインポートし、個人用アクセストークンでGitHub APIを呼び出す

使う前に知っておきたいこと

• !独自のfetch実装を用意しない場合、Node 18以上が必要です。
• !Node.jsは標準でプロキシ環境変数を使用しないため、プロキシエージェントを使うカスタムfetchが必要です。
• !Nodeの条件付きexportsと併用するには、tsconfig.jsonでmoduleResolutionとmoduleをnode16に設定する必要があります。

収録されている特集

トピック

よくある質問

octokit.js とは？

REST、GraphQL、GitHub App、Webhook、OAuthのクライアントを1つにまとめた、ブラウザー、Node.js、Deno向けのGitHub SDK。 octokit.jsは、JavaScriptやTypeScriptからGitHubのプラットフォームAPIを呼び出すための主要なOctokitライブラリをまとめた`octokit`パッケージです。`octokit.rest.*`メソッドまたは`octokit.request`を使ったRESTリクエストとGraphQLクエリに対応し、認証、リトライ、レート制限に応じたスロットリングを標準で備えています。

octokit.js は無料で使えますか？ライセンスは？

octokit.js は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

octokit.js は今もメンテナンスされていますか？

活発にメンテナンス中。octokit.js の最終コミットは 2026年10月28日 です。

octokit.js は何に使えますか？

issue、コメント、プルリクエストを作成するbotや自動化ツールの構築。 インストール済みリポジトリのWebhookイベントに応答するGitHub Appの開発。 WebアプリケーションへのGitHub OAuthログインの追加。 フロントエンドやNode.jsサービスからGraphQLでGitHubのデータを取得。

octokit.js のインストール方法は？

npmでoctokitパッケージをインストールする: npm install octokit Octokitをインポートし、個人用アクセストークンでGitHub APIを呼び出す

octokit.js はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/octokit/octokit.js