はじめに
スタンバイ Advent Calendar 2024の12日目を担当するUserグループの藤澤です。
普段はフロントエンド開発を行っています！
当記事では、フロントエンド開発にAPIモックを導入した際のメリットや、具体的な導入方法について紹介します。
APIモックとは
APIモックとは、仮のAPIレスポンスを返す仕組みです。
これにより、フロントエンド開発者は実際のデータを用いずにAPIの動作を確認したり、アプリケーションの挙動をテストしたりできます。
実際に感じたAPIモック導入のメリット
APIモックを導入したことで、開発プロセス全体の効率が大きく向上しました。以下に、実際に導入して感じた具体的なメリットを紹介します。
1. バックエンド開発が完了する前にフロントエンドの開発をスタートできる
APIモックを利用することで、バックエンドが完成していなくてもフロントエンドの開発を始めることができました。これにより、開発チームが並行して作業を進められるため、プロジェクト全体の開発スピードが向上しました。
2. コードレビュー時にバックエンドのAPIを取り込まなくても動作確認ができる
APIモックを使って作成した仮のAPIレスポンスを利用すれば、レビュー担当者は実際にバックエンドのAPIを呼び出して動作を確認する必要がなく、モックを操作することでフロントエンドの動作確認ができるため、レビューの効率が格段に向上しました。
3. テストコードでも作成したモックデータを使いまわせる
テスト時にも、作成したモックデータを再利用できることが大きな利点です。
特定のシナリオをテストするためにモックデータを用意し、そのデータをテストコード内で何度も使い回せるため、テストの維持管理が簡単です。
これにより、ユニットテストや結合テストの際に一貫したデータを使用することができ、テストの信頼性を高めることができました。
また、テストデータを手動で作成する手間も省けるため、テストの効率も良くなりました。
4. ニッチなケースを手軽にモックを編集して再現できる
APIモックを使うことで特定のケースやニッチな状況を手軽に再現出来る様になりました！
普段開発しているスタンバイには様々な求人パターンがあり、様々なデータパターンで挙動を確認したい時にAPIをせっせと叩かなくて良くなった恩恵は大きいです！
MSWとは
MSW (Mock Service Worker)は、ブラウザとNode.jsのネットワークレベルでモックAPIを実現するためのライブラリです。
これにより、フロントエンドとバックエンドの開発を分離し、様々なシチュエーションを再現できます。
主な特徴には以下があります！
- ネットワークレベルでリクエストをキャッチしてモックレスポンスを返す
- SSRとCSRの両方に対応している
- ローカル開発、Vitestによる結合テスト、Storybookにも結合できる
プロジェクトへの導入
スタンバイのWebフロントエンドではSSRとCSRの場合で利用するAPIを使い分けています。
今回は以下のAPIを使い分ける想定で説明して行きます！
-
/api/top-player：CSR用のAPI。プレミアリーグのトッププレイヤーのデータを返す -
/api/top-teams：SSR用のAPI。プレミアリーグの順位を返す
1. MSWインストール
yarn add msw --dev
必要に応じて、CDNからMSWをインストールすることもできます。
2. モックデータを用意する
今回は、テスト用の例として、CSRとSSRで返すAPIモックを以下のように定義しました。
// CSR用のモックデータ
const topPlayersMockResponse = {
players: [
{ name: "Bukayo Saka", team: "Arsenal" },
{ name: "Mohamed Salah", team: "Livepool" },
{ name: "Cole Palmer", team: "Chelsea" },
],
};
// SSR用のモックデータ
const topTeamsMockResponse = {
ranking: [
{ rank: 1, team: "Livepool" },
{ rank: 2, team: "Chelsea" },
{ rank: 3, team: "Arsenal" },
],
};
3. リクエストハンドラを作成する
リクエストハンドラは、どのリクエストをインターセプトして、レスポンスを返すかを記述する関数です！
以下のコードでは/api/top-playerのレスポンスにtopPlayersMockResponse、/api/top-teamsのレスポンスにtopTeamsMockResponseを返す様に記述しています！
export const handlers = [
// CSR用のGETリクエスト
http.get("/api/top-players", () => {
return HttpResponse.json(topPlayersMockResponse);
}),
// SSR用のGETリクエスト
http.get("/api/top-teams", () => {
return HttpResponse.json(topTeamsMockResponse);
}),
];
4. Node.jsの統合
SSRを有効にする為には、Node.jsへの統合が必要になります。
まずは設定を行います。
import { setupServer } from "msw/node";
import { handlers } from "./handlers";
export const server = setupServer(...handlers);
次にAPIモックを有効にして行きます！
import { defineNuxtPlugin, useRuntimeConfig } from "#app";
import { server } from "@/mocks/msw/server";
export default defineNuxtPlugin(async () => {
const config = useRuntimeConfig();
const useMsw = config.public.USE_MSW;
if (useMsw) server.listen();
});
useMswという変数がtrueの時に、APIモックが有効になります！
5. ブラウザの統合
CSR側も有効にするには、ブラウザへの統合も行なう必要があります。
以下のコマンドでmockServiceWorker.jsを生成します！
npx msw init <PUBLIC_DIR> --save
次に設定を行います！
import { setupWorker } from "msw/browser";
import { handlers } from "./handlers";
export const worker = setupWorker(...handlers);
最後にモックを有効化したい時だけ、worker.startでService Workerをアクティブする様に記述して行きます！
import { defineNuxtPlugin, useRuntimeConfig } from "#app";
import { worker } from "@/mocks/msw/browser";
export default defineNuxtPlugin(async () => {
const config = useRuntimeConfig();
const useMsw = config.public.USE_MSW;
if (useMsw) {
await worker.start();
}
});
6. scriptコマンドでmockを起動する
開発中にモックサーバーを簡単に起動できるよう、scriptコマンドを設定します。
"scripts": {
"dev": "nuxi dev",
"mock": "USE_MSW=true nuxi dev",
}
これにより、yarn mockを実行すればサーバー側とクライアント側のAPIモックが有効化されます！
7. mockServiceWorker.jsは本番ビルドに含めない
mockServiceWorker.jsのファイル内をみると以下の内容が書いてあります。
- 自動生成ファイルだから修正しないでね！
- 本番ビルド時は含めないでね！
修正は必要ないので無視しますが、本番ビルド時にmockServiceWorker.jsを含まないようにする処理は自前で書く必要があります！
一例として僕たちはNuxtのhooksを使って、本番ビルド時は生成後のmockServiceWorker.jsを削除する方針を取りました！
hooks: {
"nitro:build:public-assets": async () => {
const path = await import("path");
const fs = await import("fs");
const outputDir = path.resolve(__dirname, ".output/public");
const fileToExclude = "mockServiceWorker.js";
const filePath = path.join(outputDir, fileToExclude);
if (fs.existsSync(filePath)) {
fs.unlinkSync(filePath);
}
},
},
削除のタイミングは、Nitroサーバーの構築前でmockServiceWorker.js生成後であるnitro:build:public-assetsを採用しています！
参考：Nuxtのライフサイクルについて
さて、ここまでやればプロジェクトへの導入は完了です🙆
期待するデータが取得出来ているか確認しましょう！
yarn mock
ブラウザ側でMSWが有効になっていれば、devtoolのconsoleに以下の表示が出ます！
実際のコード上でモックAPI化した/api/top-player、/api/top-teamsを叩くとモックで定義したデータが返って来ます！
まとめ
この記事では、MSWを使ってAPIモックをプロジェクトに導入する方法を詳細に説明しました。
これにより、バックエンドの開発が進む前にフロントエンドの開発を開始し、様々なシナリオをテストしやすくなります。
MSWはブラウザとNode.jsの両方で動作し、開発の柔軟性を高めてくれます。