Github API v 3の使用方法、ハブAPIの使用方法
これを契機にAPI v 3の簡単な使い方を紹介します.
コインを発行する
バニラの
Settings -> Developer settings -> Personal access tokens
に向かい、Generate new token
をクリックすると、上記の画面が表示されます.Note
に希望するトークン名を書き、scope
を選択します.筆者は
repo
万生成を選んだ.生成が完了すると、
토큰 값
が表示されます.タグは作成時にのみ表示されるため、コピーして他の場所に保存する必要があります.
忘れてしまったら、補充しなければならないので、気をつけてください.
ただし、認証を行わない場合、要求は1時間60回に制限されます.
認証をすれば、1時間に5000回まで申請できます.
Github API v3
上のリンクはgithub APIドキュメントです.
使用方法の説明がよく、複数のAPIが使用できます.
筆者はここで
ISSUE
を使用します.ISSUE
をクリックし、使用上の問題のapiを表示します.repository의 이슈 리스트
が作成され、「List repository issues
」をクリックします.List repository issues
の使い方や注意事項が表示されます.これは、
GET /repos/:owner/:repo/issues
という方法でAPIを要求することを意味する.リポジトリの所有者が
hyun-jii
であれば、repositoyの名前はtest
です.https://api.github.com/repos/hyun-jii/test/issues
GET
で上記のURLをリクエストします.type
と説明が与えられる.このパラメータを使用する場合は、参照してください.
以上より、応答オブジェクトの構造を理解し、各イベントで得られる情報を理解できます.
この話題をスクロールするtitle、state、user、label、numberなど、さまざまな情報を活用できます.
筆者は簡単なテストで,各話題のtitleのみを抽出した.
<h1>Issue List</h1>
<div class="container"></div>
$(document).ready(function () {
var auth = window.btoa("hyun-jii: 토큰 값 ");
$.ajax({
type: "GET",
headers: {
Authorization: "Basic " + auth,
},
url: "https://api.github.com/repos/hyun-jii/CRESCENDO/issues",
dataType: "json",
success: function (response) {
var array = response;
for (var i = 0; i < array.length; i++) {
$(".container").append("<p>" + array[i].title + "</p>");
}
},
});
});
指定されたフォーマットの
GET
URL
認証トークンがheaders
で要求される.window.btoa()
はBase 64符号化方法である.title
が抽出された.APIドキュメントではtitleが最初の外部配列にスタックされるためarray[i].titleに精製する.
user 의 id
を救いたいならarray[i].user.idlabel name
を取得するには、二重繰り返し文配列[i]を使用します.label[j].nameで抽出します.現在公開されている話題だけが出てきますが、すべての話題や閉じた話題だけを見たい場合はurlに追加できます.
issues?stae=all
のほか、ページ設定やラベルなど、さまざまな設定方法がありますので、ドキュメントを参照してください.トークン認証方法
https://developer.github.com/v3/auth/
筆者は
Basic Authentication
を利用して認証を行った.var auth = window.btoa("hyun-jii: 토큰 값 ");
headers: {
Authorization: "Basic " + auth
}
Base64
符号化により認証する方式が採用されている.しかし
Base64
符号化は復号可能であり、安全性が悪い.そのため、HTTPS/TLSを使用することをお勧めします.
初めてGithub APIを使うのですが、使うのは難しくなく、思ったより多くのAPIが提供されています.
次回は他のAPIを利用して、面白いものを作りたいと思います.
Reference
https://developer.mozilla.org/ko/docs/Web/HTTP/Authentication
Reference
この問題について(Github API v 3の使用方法、ハブAPIの使用方法), 我々は、より多くの情報をここで見つけました https://velog.io/@hyun-jii/Github-API-v3-사용방법-깃허브-API-적용テキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol