Groovyラボ

らくらくシーケンス図：WebSequenceDiagrams #apijp

これはWeb API Advent Calendar 2014、7日目のエントリです。知っている方も多いと思いますが、ツールの小ネタで。

Web APIを扱っていると、認証やマッシュアップのフローの記述など、簡単なシーケンス図を書きたくなる場合がよくあります。こんなときにオススメなのが、カナダのHanov Solutions社が提供する便利なWebサービスWebSequenceDiagrams。

次のようなシンプルなテキストを書くだけで：

title GWでのmashup

アプリ->GW: POST 郵便番号
GW->サービスA: GET /郵便番号
サービスA->GW: 住所(JSON)
GW->サービスB: POST 住所
サービスB->GW: 緯度経度(XML)
GW->アプリ: 緯度経度(JSON)

次のようなイメージを生成してくれます：

基本的に無償で使えますし、生成した図は直接リンクして使うこともPNGイメージとしてexportすることもできて非常に便利です。スタイルもいくつか用意されています。例：

ちゃんとAPIも用意されているので他のツールや言語と組み合わせるのも簡単。有償のプレミアム版では図の編集に追従するリンクの生成、より高度や記法やPDF/SVGでのexportなどもサポートされます。

シンプルですが非常に使い勝手の良いツールで、あなたのAPIツール箱にそろえておきたい優れものの一つです。

Permalink | コメント(0) | トラックバック(0)