おはこんばんちは!! 尾藤 a.k.a. BTO です。 Web APIの仕様の定義ってみなさんどうされているでしょうか。 人によって書き方がバラバラだったり、定義に過不足があったりしてないでしょうか。 Web APIのインターフェースで定義する内容は、ほとんど決まってます。 もっと形式的な書き方できないだろうかと探してみたら、やはり同じ事を考えている人がいて、API Blueprintというのを見つけました。 API Blueprint - API Documentation with powerful tooling API Blueprintを使うとMarkdownでAPIの定義ができます。 できること APIの記述フォーマットが決まっていますので、どこで何が定義されているかが分かります。 ですので、機械的に処理する事ができるようになります。 具体的には、 APIドキュメントの生成
![APIの仕様をMarkdownで定義する - HDE BLOG](https://cdn-ak-scissors.b.st-hatena.com/image/square/742e595340f9e50948c26f4c4a820c8ea0a13f8d/height=288;version=1;width=512/http%3A%2F%2Fcdn-ak.f.st-hatena.com%2Fimages%2Ffotolife%2Fm%2Fmasatobito%2F20150116%2F20150116124624.png)