2016年3月28日月曜日

API Blueprint の構文

イメージ

API Blueprint は Web API の仕様を記述するためのマークアップ言語です。マークアップの構文は Markdown から拡張されています。

FORMAT: 1A

# NervousKidKitten
神経質な子供の子猫の Web API です。

# Group Greethings
挨拶に関連したすべてのリソースのグループです。

## メッセージ [/message]

### メッセージを取得 [GET]

+ Response 200 (text/plain)

        Hello World!

API Blueprint をサポートする様々なツールを使うことにより、Web API のモック サーバーを立ち上げたり、API ドキュメントの生成などが簡単に行えるようになります。

ここでは、公式のチュートリアルを基にして API Blueprint の構文について簡単に説明します。