REST API について

REST API のドキュメントを参照してください。

この記事で

GitHub の API を使用すると、プロセスを自動化し、GitHub と統合し、GitHub を拡張するスクリプトとアプリケーションをビルドできます。 たとえば、API を使用して、問題のトリアージ、分析ダッシュボードのビルド、リリースの管理を行うことができます。

各 REST API エンドポイントは個別に文書化され、エンドポイントは主に影響を受けるリソースによって分類されます。 たとえば、「問題用の REST API エンドポイント」の issue に関連するエンドポイントを見つけることができます。

REST API を使用した作業の開始

          **REST API を初めて使用する場合**は、クイック スタートまたは概要ガイドをはじめに参照すると役立つ場合があります。 詳細については、以下を参照してください:

* GitHub REST API のクイック スタート * REST API を使用した作業の開始

          **REST API に慣れている**が、GitHub の REST API を初めて使用する場合は、認証ドキュメントを参照すると役立つ場合があります。 詳細については、以下を参照してください:

* REST API に対する認証

REST API を使用するスクリプトまたはアプリケーションをビルドする場合は、次のガイドの一部が役立つ場合があります。 REST API を使用したスクリプトの例については、次を参照してください。

  •         [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)

  •         [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-ruby)

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events)

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-cli-with-a-github-app)

  •         [AUTOTITLE](/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook)

REST API を使用したスクリプト作成を容易にするライブラリの一覧については、「REST API のライブラリ」を参照してください。

REST API を使用するスクリプトまたはアプリケーションをビルドする場合、Webhook を使用してイベントに関する通知を受け取ったり、ユーザーの代わりに、または組織内で GitHub App を使用してリソースにアクセスしたりすることにも興味をもたれるかもしれません。 詳細については、「webhook について」および「GitHub アプリをビルドするタイミングを決定する」を参照してください。

参考資料

  •         [AUTOTITLE](/rest/overview/comparing-githubs-rest-api-and-graphql-api)

  •         [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)

  •         [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)

  •         [AUTOTITLE](/rest/overview/troubleshooting-the-rest-api)