30 lines
1.8 KiB
Markdown
30 lines
1.8 KiB
Markdown
|
# Mock Service Worker Example
|
||
|
|
|
||
|
|
[Mock Service Worker](https://github.com/mswjs/msw) is an API mocking library for browser and Node. It provides seamless mocking by interception of actual requests on the network level using Service Worker API. This makes your application unaware of any mocking being at place.
|
||
|
|
|
||
|
|
In this example we integrate Mock Service Worker with Next by following the next steps:
|
||
|
|
|
||
|
|
1. Define a set of [request handlers](./mocks/handlers.js) shared between client and server.
|
||
|
|
1. Setup a [Service Worker instance](./mocks/browser.js) that would intercept all runtime client-side requests via `setupWorker` function.
|
||
|
|
1. Setup a ["server" instance](./mocks/server.js) to intercept any server/build time requests (e.g. the one happening in `getServerSideProps`) via `setupServer` function.
|
||
|
|
|
||
|
|
Mocking is enabled using the `NEXT_PUBLIC_API_MOCKING` environment variable, which for the sake of the example is saved inside `.env` instead of `.env.development`. In a real app you should move the variable to `.env.development` because mocking should only be done for development.
|
||
|
|
|
||
|
|
## Deploy your own
|
||
|
|
|
||
|
|
Deploy the example using [Vercel](https://vercel.com):
|
||
|
|
|
||
|
|
[](https://vercel.com/import/project?template=https://github.com/vercel/next.js/tree/canary/examples/with-msw)
|
||
|
|
|
||
|
|
## How to use
|
||
|
|
|
||
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npx create-next-app --example with-msw with-msw-app
|
||
|
|
# or
|
||
|
|
yarn create next-app --example with-msw with-msw-app
|
||
|
|
```
|
||
|
|
|
||
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|