RedmineのREST APIを使ってみる。

いまごろではありますが、主に使っているRedmineのバージョンが上がったので、やっとREST APIが使える環境になりました。
#個人的にREST APIを使ったツールを作ってみる活動はしていたのですが、メインの環境では対応していなかったのもあって、モチベーションが続いてませんでした…。

できれば周りにも利用したり、応用したり、良いアイディアを出してもらいたいなあと思ったので、まずはどんな感じで使えるか、というサンプルを作ることにしました。

* * *

チケットの参照はWebから行うことの方が多いので、やっぱりチケットを作るサンプルから。

参考にさせていただいたREST APIについての記述は、Redmine本家と、r-labsのサイトの日本語訳になります。（ありがとうございます！）

• http://www.redmine.org/projects/redmine/wiki/Rest_api (Redmine.orgのWiki)
• http://www.r-labs.org/projects/r-labs/wiki/Redmine_REST_API (r-labsの日本語訳)

動作確認は、daipresentsさんの記事を参考にさせていただきました。こちらもありがとうございます！

• http://daipresents.com/2010/redmine_rest_api_test/

daipresentsさんの記事では、RESTを試すクライアントとして、RESTClient を使われていました。こちらは使ったことが無かったので、ダウンロードしてみたところ、なるほど、これも便利でした。
わたしの場合は、いつもはFiddler2 を使っているので、参考までにFiddler2でのスクリーンショットを載せておきます。

1枚目がPOSTメソッドでリクエストを生成するところ。2枚目がレスポンスの画面です。
うまくチケットが出来ると、Status Code 201が返ってきます。また、レスポンス本文にも、チケットのIDを含めたXMLが返ってきます。

動作確認ができたので、じゃあ、チケットを作成するプログラムを…と思ったのですが、RubyやPerl, Pythonといったライブラリの組み込み状況は、サーバの環境によってまちまち。Perlしか入れていないところもあります。

現在のチケット作成のAPIは、添付ファイル付きでの作成が出来ず、結局のところXMLをPOSTすることになるので、シンプル？に、curlとShellを使ったスクリプトを作ることにしました。

• スクリプトはこちら：
  https://github.com/akiko-pusu/misc/blob/master/misc/redmine_postIssue.sh

チケット作成がメインで、Statusの指定やカテゴリの指定は重視していなかったので、オプション設定は行っていません。Shellを参考にカスタマイズすれば、Updateやカテゴリ設定も可能かと思います。（実はまだUpdateは試してないので、できたらまた追記します）

使い方は、このような感じです。

$redmine_postIssue.sh –u REDMINEのURL –k APIキー \
   –p プロジェクトID(番号じゃなく識別子)  \
  -t トラッカーID(番号) –s タイトル \
  -d チケット本文

チケット作成時に、作成者を別途指定できたり、担当者も指定できます。ただ、やっぱり担当者とかトラッカーとかのIDをきちんと知っていないといけません。

APIを使ってリッチなクライアントを作るって、凄いなあと思っています(^^;