📌

json-server を使って手軽にモックサーバーを構築してみる

2023/02/28に公開

フロントエンドの開発時にAPIがローカルから利用できないときって困りますよね。
そんな時に手軽にAPIをモックする環境を構築出来たら便利だと思います。
json-server というライブラリを用いてローカルでAPIを簡単にモックする環境を構築します。

やりたかったこと

他にもjson-serverで環境を構築する記事はいくつかありましたが、今回私が意識した点は以下です。

  • docker-composeで環境を作りたい
  • APIの各パスに対して、別々のjsonファイルを用意したい
     → レスポンスの量が大きくなると1つのファイルだけだと見づらくなるため
  • ホットリロードを設定したい
     → 変更をすぐに反映できるようにするため

実装してみる

コードはこちらに格納しました。
https://github.com/shinkawa-shinji-japan/json-server-example

所感

簡単にAPIのモックを用意することができました。
少しは開発が捗りそうです。
理想としては、

  • swaggerでAPI仕様を作成し、exampleに記載したデータをモックできるようにして、exampleの値は複数用意可能かつ別ファイルから参照できる
    かな。
    いつか機会があれば着手します!!

Discussion