読者です 読者をやめる 読者になる 読者になる

mmts1007’s diary

プログラミング関連の技術系ブログです。

Node EasyMock で API モックサーバを作る

Node EasyMock を使って、API モックを作ってみた。

github.com

フロントエンド:Angular JS
バックエンド:Spring Boot
という感じでアプリを作っているのですが、フロントエンドから作りたくなったので使ってみました。

インストール

基本的には README の通り

$ npm install -g easymock
$ easymock

で動作しました。

ただし、node のバージョンの指定があるようで v5.0.0 で実行したときに下記のメッセージが表示されました。

wanted: {"node":">= 0.10.0 < 0.11.0 || >= 0.11.13 < 0.13.0 || >= 1.0.0 < 2.0.0"} (current: {"node":"5.0.0","npm":"3.3.6"})

ということで、今は v0.12.7 を使用しています。

API モック

Node EasyMock は URL、HTTP Method と対応する JSON ファイルの内容を返却します。
例えば、GET /users をリクエストした場合 users_get.json ファイルの内容を返却します。 [URL]_[HTTP Method].json の形式でファイルを用意するだけで、API モックを作ることができます。

また、/users/1/ などのネストした URL の場合は users ディレクトリ配下に 1_get.json を配置します。

ログとドキュメント

Node EasyMock はログとドキュメントを表示する機能もあります。 /_documentation/ にアクセスすると API ドキュメントを表示することができます。

ドキュメントでは API の一覧を確認することができます。

f:id:mmts1007:20151121235050p:plain

エンドポイントをクリックすると、対象のエンドポイントのレスポンスを確認することができます。

f:id:mmts1007:20151121235250p:plain

同様に /_logs/ にアクセスすると、アクセスログを確認することができます。

f:id:mmts1007:20151122000101p:plain

まとめ

フロントエンドの開発とバックエンドの開発が並行して進む場合など、バックエンドがまだ出来ていないときに利用してみてはいかがでしょうか? JSON ファイルのみ用意できれば使用できるので、学習コストも低くて良いと思います。