このページのメモ

Getting started with the REST API - GitHub Docs

Overview(概要)

• ほとんどのアプリケーションは、選択した言語で既存のラッパーライブラリを使用しますが、最初に基礎となるAPIのHTTPメソッドに慣れることが重要です。
  • ラッパーライブラリ：ある開発環境向けに提供されたプログラムなどを別の環境で利用できるようにするものをラッパーという。
  • ラッパー（wrapper）とは \- 意味をわかりやすく \- IT用語辞典 e\-Words
  • octokit.rbもこれの一種。GitHubとRubyだと環境全然違うので、RubyでGitHubAPIを使えるようにするものだと思う。
• cURLを使うのが一番簡単な方法です。 他のクライアントを使用している場合、リクエストに有効なUser Agentヘッダを送信する必要があることに注意してください。

Hello World

• *curl [<https://api.github.com/users/>](<https://api.github.com/users/defunkt>)<GitHub*のID名> で、JSON形式でプロフィール情報が取れる
  • GitHubのID名 とは、画像で言う Saki-htr のこと。

• -i オプション：HTTPヘッダ情報も取れる

  X-RateLimit-LimitとX-RateLimit-Remainingヘッダにも注目してください。このヘッダのペアは、クライアントがある時間内(通常1時間)にどれだけのリクエストを行うことができるか、そしてそのうちのどれだけのリクエストをクライアントがすでに使ってしまったかを示しています。

Authentication

• 未認証のクライアントは1時間に60回のリクエストが可能です。
• もっと多くのリクエストを一時間あたりに行うには、認証が必要になります。実際、GitHub API で何か面白いことをするときには認証が必要です。

Using personal access tokens (パーソナルアクセストークンの使用)

• GitHub API で認証を行うには、OAuth トークンを使った Basic 認証が最も簡単でよい方法です。OAuth トークンには、個人用のアクセストークンも含まれます。

  • 🤔 個人用のアクセストークン=この前作ったやつ。Railsのomniauthの課題で作ったのもこれ。

    https://github.com/settings/tokens