Web APIの設計にUI Flowsはすごく便利だった

以前、全てがJSONになる - ✘╹◡╹✘ を読んでなるほどなーって具合にpocketに突っ込んでいたんだけど、最近Web API設計をする機会があったので、を参考にIF仕様をJSON Schemaで作成することにした。

IF仕様書というと

  • エンドポイント定義
  • リクエストデータ定義
  • レスポンスデータ定義

みたいな構成になるかと思うんだけど、そもそもエンドポイントをどうやって導くかみたいな話になって。取り敢えず画面遷移図みたいなんが欲しいねってことに。

ただ、僕らみたいなプログラマって、PhotoshopだったりExcelだったりで画面を定義するのはちょっと辛いじゃない。そこで、これも以前pocketに入れていた 画面遷移に疑問を感じたあなたにオススメするUI Flowsというツール | Reflection | UIデザイン会社Standard Incのブログ を参考にcacooでUI Flowsを簡単に記述して、その矢印に対してエンドポイントを付ける、みたいなやり方でやってみた。

結果、作業的に割りとスムーズにエンドポイントとレスポンスデータの定義が出来た。これには少し驚いてる。 ただ、まだちょっとJSON Schemaの書き方がわからなくて英語と格闘中なう。