Skip to main content

Guides

REST APIおよび認証の初歩や、さまざまなタスクでREST APIを使用する方法について学びましょう。

ドキュメントのこのセクションは、実際の GitHub API アプリケーションを稼働させるためのものです。 認証から、結果の操作や結果とその他のアプリとの統合に至るまで、知っておく必要があるすべての内容について説明します。 チュートリアルにはそれぞれプロジェクトが含まれています。各プロジェクトは、パブリックの platform-samples リポジトリに保存され、文書化されます。

REST API と JavaScript を使用したスクリプト

Octokit.js SDK を使用して REST API と対話するスクリプトを記述します。

REST API と Ruby を使用したスクリプト

Octokit.rb SDK を使用して REST API と対話するスクリプトを記述する方法を説明します。

ユーザのリソースを調べる

REST APIに対する認証済みリクエストにおいて、アプリケーションがアクセスできるユーザのリポジトリやOrganizationを確実に調べる方法を学びます。

デプロイメントを配信する

Deployment REST APIを使用すると、サーバーおよびサードパーティアプリケーションとやり取りするカスタムツールを構築できます。

データをグラフとしてレンダリングする

D3.jsライブラリとRuby Octokitを使用して、リポジトリからプログラミング言語を視覚化する方法を学びましょう。

コメントを扱う

REST API を使用すると、プルリクエスト、Issue、およびコミットにある、コメントにアクセスして管理できます。

CIサーバーの構築

Status APIで独自のCIシステムを構築しましょう。

REST API を使って Git データベースを操作する

REST API を使って、GitHub Enterprise Cloud 上の Git データベースに対して raw 形式の Git オブジェクトを読み書きしたり、リファレンス (ブランチ head やタグ) の一覧表示や更新を行ったりします。

REST API を使用してチェックを操作する

REST API を使って、リポジトリでのコード変更に対して強力なチェックを行う GitHub Apps を構築できます。 継続的インテグレーション、コードの構文チェック、コードのスキャンサービスを実行し、コミットについて詳細なフィードバックを行うアプリを作成できます。

REST API のシークレットの暗号化

REST API を使ってシークレットを作成または更新するには、シークレットの値を暗号化する必要があります。