「ひろの」の徒然日記帳 [IT tools, programming, software and more...]

プログラミング、ITツール、人工知能等興味のあることを徒然と書きます。Microsoft好きです

apiary による Markdown記法、API設計

ひろのです。


4月ももう中旬です。
あっという間にゴールデンウィークがやってきて、夏がきて、、、と
1年が過ぎていくのかもしれません。
ここ数年成長が止まっていたと実感しているので、
少しずつ取り返していきます。


最近新しいAPIの設計を始めています。
まだ初期の初期なのでホワイトボードを使ったり、エクセルでラフに
リクエスト・レスポンスを整理したりといった段階ですが、
Web上で便利な apiary というサービスがあるので記事にしました。


apiary.io



APIの設計、ドキュメントが Markdown の形式で書け、
簡単にそして見栄え良く出来ます。

画面は3分割され、左からMarkdown形式でドキュメントを書くと、
真ん中に人が見やすいドキュメントが自動生成されます。
さらに右側には機械向けのドキュメントやコードが生成されます。


f:id:ino-hiro1012:20160413124950p:plain



REST APIのドキュメントを書くだけではなく、実際にモックアップを実行したり
サンプルのコードを提供してくれたりもします。


無料で使えますが、チームでの利用やプライベートなAPIドキュメントを
書く場合は有料になります。