naoya / api-blueprint-example

API Blueprintのサンプル

Api Blueprintのサンプル

使い方

※詳しくはpackage.jsonを参照してみてください

準備

$ npm install

ライブリロードしながらドキュメントを編集

$ npm run aglio:watch

ドキュメントのコンパイル

$ npm run aglio:compile

ドキュメントのマージ

$ npm run aglio:merge

Mockサーバー立ち上げ

$ npm run mock

Dreddでテストを実行

• ※デモで実行する場合、事前にバックグランドでMockサーバーを立ち上げておくこと。
• ※実際に運用で利用する際はMockサーバーではなく、APIアプリケーションサーバーを使うこと。

$ npm test