GitLabのAPIの概要
GitLabはAPIを提供しています。
そのAPIを使用することで、GitLabにログインせずにプロジェクトやissueの情報を取得したり、独自に便利なアプリを作成したりすることもできます。
今回はそのようなAPIを使うための方法を紹介します。
Access Tokenの取得
GitLabのAPIを使うためにはPersonal Access Tokenが必要になります。
GitLabにリクエスト通信時にこのPersonal Access Tokenをパラメーターとして付加することで、GitLab側で認証が行われ、GitLabにあるプロジェクトの情報などを取得したりできる仕組みになっています。
では、Personal Access Tokenの設定をしてみましょう。
画面右側の個人設定のSettingをクリックします。
次に画面左側メニューの『Access Tokens』をクリックします。
Nameにはトークンの名前を入力します。
作成するトークンに有効期限を設定したい場合は、Expires atに有効期限を入力しましょう。
Expires atが空白の場合は有効期限は無期限設定になります。
Scopesはapiを選択します。
ここまで入力できたら、『Create personal access token』をクリックします。
これでPersonal Access Tokenが作成され、画面に表示されます。
このPersonal Access Tokenは表示されている画面を消すと、二度と表示されないので忘れずメモしておきましょう。
万が一、忘れてしまった場合は新しくPersonal Access Tokenを作成し直して、不要になったPersonal Access Tokenは削除しておけば良いです。
これでGitLabのAPIを使うための準備ができました。
今度はAPIを使う簡単なアプリをPythonで実装してみたいと思います。
コメント