GitHubの API を使用して、プロセスの自動化、GitHubとの統合、GitHubの拡張を行うスクリプトとアプリケーションを構築できます。 たとえば、API を使用して、問題のトリアージ、分析ダッシュボードのビルド、リリースの管理を行うことができます。
各 REST API エンドポイントは個別に文書化され、エンドポイントは主に影響を受けるリソースによって分類されます。 たとえば、「問題用の REST API エンドポイント」の issue に関連するエンドポイントを見つけることができます。
REST API を使用した作業の開始
REST API を初めて使用する場合は、クイック スタートまたは概要ガイドをはじめに参照すると役立つ場合があります。 詳細については、以下を参照してください:
REST API に慣れている が、 GitHubの REST API を初めて使用する場合は、認証ドキュメントを参照すると役立つ場合があります。 詳細については、以下を参照してください:
REST API を使用するスクリプトまたはアプリケーションをビルドする場合は、次のガイドの一部が役立つ場合があります。 REST API を使用したスクリプトの例については、次を参照してください。
- REST API と JavaScript を使用したスクリプト
- REST API と Ruby を使用したスクリプト
- webhook イベントに応答するGitHub アプリの構築
- GitHub アプリを使用した CLI の構築
- リポジトリの Webhook の失敗した配信を自動的に再配信する
REST API を使用したスクリプト作成を容易にするライブラリの一覧については、「REST API のライブラリ」を参照してください。
REST API を使用するスクリプトまたはアプリケーションを作成する場合は、Webhook を使用して、ユーザーまたは組織内のリソースにアクセスするためのイベントまたは GitHub App に関する通知を受け取ることにも関心があります。 詳細については、「webhook について」および「GitHub アプリをビルドするタイミングを決定する」を参照してください。