Tech Notes

GiteaをAPIで制御する

全然日本語の文献が無かったけど案外簡単に出来るやつだったのでメモ。情報源は主にここ

Giteaで使えるAPIの一覧解説はここで見れる。 このページ、表示までに数十秒かかるので注意。 個別のAPIについてはこれさえ見れば全部詳細に分かるので言うことなし。

ここでは例としてユーザー情報を取得する「/user」エンドポイントのAPIを叩いてみるが、他のAPIも基本は同じ感じでできる。

まずAPIを使うユーザーでGiteaにログインして、ユーザーの「設定」→「アプリケーション」の画面からトークンを生成してメモる。トークン名はただのラベルなので何でもいい。準備はこれだけでOK。

「https://(giteaのURL)/api/v1/user?token=(メモったトークン)」にアクセスするとユーザー情報が見れる。非常に簡単。他のAPIも同様で、/api/v1/(APIのパス)にGETパラメータでトークン情報を渡せばアクセスできる。なお、GETパラメータ以外にHTTPヘッダを使ってもトークンを渡せるっぽいのだがそちらは試していない。

ちなみにAPI一覧解説のページにbase URL: /api/v1と書いてある。将来Giteaのメジャーバージョンが上がったらv2も出てくるのかも知れない。