JavaScriptでモックAPIサーバーを作成する方法
David Ekete
2022年10月20日
14 分で読めますフロントエンド機能の
このような
この
モックAPIサーバーとは
モックAPIサーバーとは、
モックAPIサーバーは、
モックAPIサーバーは、
開発:モックAPIサーバーを
使うと、 フロントエンドチームと バックエンドチームの 依存関係を 一時的に 解消できます。 それぞれの チームが 独立して 作業、 開発、 テストを 進められます。 テスト:ソフトウェア開発に
欠かせない テストを、 フロントエンドチームが バックエンドチームに よる 完全な APIの 開発を 待たずに 実施できます。 また、 すべての テストリクエストが 実際の APIではなく モックAPIサーバーに 送られる ため、 実際の APIが テストデータで 汚染される ことも 防げます。 外部コンポーネント:Storybookなどの
ツールを 使って フロントエンド機能を 紹介する 際、 モックAPIサーバーを 使って 外部依存関係を 模擬する こともできます。
モックAPIのベストプラクティス
モックAPIサーバーを
モックAPIは、
実際の APIと 同じ スキーマと インターフェースに 対応している 必要が あります。 これに より、 レスポンスを より 現実的な ものに できます。 アプリケーションに
外部依存関係が ある 場合は、 モックAPIでも それらを 模擬する 必要が あります。 モックAPIは、
リクエストの 転送に 対応している 必要が あります。 これに より、 実際の APIが 開発された 後、 モックレスポンスから 実際の レスポンスへ 段階的に 切り替えられます。 モックAPIでは、
予期しない エラーや パフォーマンスの 低下、 無効な ユーザー入力を シミュレートできるようにします。 こうする ことで、 アプリケーションが これらの 状況に 適切に 対応できるようになります。
APIモックツール
モックAPIサーバーの
Mock Service Worker (MSW):Mock Service Workerは、Service Worker APIを
利用する APIモックライブラリです。 この APIに より、 MSWは プロキシサーバーと して 実際の リクエストを インターセプトし、 モックレスポンスを 返せます。 リクエストの インターセプトは ネットワークレベルで 行われる ため、 アプリケーションは レスポンスが モックAPIから 返されている ことを 認識しません。 Postman:Postmanは、
APIの 構築、 使用、 テスト、 ドキュメント作成を 行う ための プラットフォームです。 保存済みの モックデータを 返すモックAPIサーバーも 作成できます。 Postmanは リクエストの 設定を 保存済みの サンプルと 照合し、 設定に 最も 近い データを 含む モックレスポンスを 返します。 操作しやすい GUIを 備えている ため、 Postmanの モックサーバーを 簡単に セットアップできます。 Mirage JS:Mirage JSは、
バックエンドサービスに 依存せずに JavaScriptアプリケーションを 構築・テストできる APIモックライブラリです。 動的な シナリオを 簡単に 作成できる ため、 モックAPIを より 現実的な ものに できます。 動的な シナリオを 作成でき、 インメモリデータベースも 備えている Mirage JSは、 モックAPIサーバーを 作成する うえで 最も 柔軟な 選択肢です。
Mirage JSでモックAPIサーバーを作成する
この
前提条件
始める
エディターで
モックサーバーをセットアップする
ターミナルで
ウィジェットが

srcディレクトリにmock.jsと
上記のmiragejsからcreateServerを
createMockServer関数は、
インメモリのモックデータベースを作成する
次に、
mock.jsファイルを
修正後のmiragejsからModelも
次に、createServerにmodelsプロパティにmodelsプロパティのtodosにmodelをtodosコレクションを
インメモリデータベースにデータを登録する
次に、seedsフックをseedsフックを
データベースにcreateServerのmodelsプロパティの
上記のseedsフックをseedsフックは、
次に、createメソッドをcreateメソッドは
モックルートハンドラーを定義する
次に、routesフックをroutesフックでは、
APIcreateServerのseedsフックの
上記のroutesフックをapi/todos)を
次に、getメソッドをGETルートハンドラーをschema引数にrequest引数も
最後に、schema.todosでallメソッドをtodoをschema引数にallメソッドは、modelNameとmodelsのCollectionオブジェクトを
modelNameプロパティはmodelsプロパティは
次のroutesフックにPOSTルートハンドラーを
上記のfalseにidをidを
次のroutesフックにPATCHルートハンドラーを
上記のparamsオブジェクトからidプロパティをfindメソッドをidをupdateメソッドを
次のroutesフックにDELETEルートハンドラーを
このparamsオブジェクトからidプロパティをfindメソッドをidをdestroyメソッドを
完成した
最後に、createMockServer関数をApp.jsファイルにApp.jsファイル内でcreateMockServer関数を
たとえば、
Reactアプリケーションを

これで、
モックAPIサーバーのまとめ
この
開発プロセスに



