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