REST APIのStubを手早い立上げにMockoonを使った記録#

REST APIの本実装が遅れてたり、昔作ったスタブが動かなくなっていたり、ともかく急ぎで、フロントエンド開発や結合テストを行う必要性に迫られるケースという局面に最近よく遭遇します。とにかく「今すぐ」「最低限のStubが必要」という状況でMockoonが便利そうなので導入手順をまとめました。

背景と目的 #

この条件をすべて満たす手段として、Mockoon を採用しました。

Mockoon は、GUIベースでREST APIのStubを定義できる無料のツールです。

特徴：

Windowsの場合Microfost Storeからインストール可能です。他のOSは公式サイトを参照してください。
Mockoonを起動し、「New environment」でStub環境を作成 - 保存のためのexploreが開くので該当環境を保存するファイル名を指定＝新環境が作成されます - ポートを任意の番号へ変更（任意）※デフォルトは3001 - 必要に応じて「Enable HTTPS」を有効化 - 必要に応じて「Enable CORS」もONにする
+ Add route で以下のようなStubエンドポイントを作成 - crudでGET/POST/PUT/DELETEの操作が自動で作成するのは新規APIの調整で便利そうですが、ここではGET/POSTなどで取り急ぎ立上げたいので「Http Route」を選択 - /api/test-resource などのエンドポイントを指定 - メソッドはGET/POST/PUT/DELETE を選択可能 - レスポンスは固定のJSONを指定できるのでRESTチームと整合したJSONサンプルを指定
サーバーを「Start」で起動し、HTTPでアクセス確認例：
```
curl -k http://localhost:3001/api/test-resource
```

flackやFastapiも選択肢として考えましたが、手早く立ち上げるには前提知識やセッティングの手間から考えて、もう少し便利なものがないかと探していたところ、Mockoonに辿り着きました。想像以上に便利で手早く立ち上げられるので非常に助かりました。同様のニーズがる方には是非お勧めしたいです。

MITライセンスということなで実プロジェクトでの利用のハードルも低いのも魅力です。Mockoonの開発者の方に感謝です。

記事情報