msw README

The project's README from github.com/mswjs/msw. As one markdown file: README.md.


The Mock Service Worker logo

Mock Service Worker

Industry standard API mocking for JavaScript.

Join our Discord server



Features


"I found MSW and was thrilled that not only could I still see the mocked responses in my DevTools, but that the mocks didn't have to be written in a Service Worker and could instead live alongside the rest of my app. This made it silly easy to adopt. The fact that I can use it for testing as well makes MSW a huge productivity booster."

— Kent C. Dodds

Documentation

This README will give you a brief overview of the library, but there's no better place to start with Mock Service Worker than its official documentation.

Examples

Courses

We've partnered with Egghead to bring you quality paid materials to learn the best practices of API mocking on the web. Please give them a shot! The royalties earned from them help sustain the project's development. Thank you.

Browser

How does it work?

In-browser usage is what sets Mock Service Worker apart from other tools. Utilizing the Service Worker API, which can intercept requests for the purpose of caching, Mock Service Worker responds to intercepted requests with your mock definition on the network level. This way your application knows nothing about the mocking.

Take a look at this quick presentation on how Mock Service Worker functions in a browser:

What is Mock Service Worker?

How is it different?

Usage example

// 1. Import the library.
import { http, HttpResponse } from 'msw'
import { setupWorker } from 'msw/browser'

// 2. Describe network behavior with request handlers.
const worker = setupWorker(
  http.get('https://github.com/octocat', ({ request, params, cookies }) => {
    return HttpResponse.json(
      {
        message: 'Mocked response',
      },
      {
        status: 202,
        statusText: 'Mocked status',
      },
    )
  }),
)

// 3. Start mocking by starting the Service Worker.
await worker.start()

Performing a GET https://github.com/octocat request in your application will result into a mocked response that you can inspect in your browser's "Network" tab:

Chrome DevTools Network screenshot with the request mocked

Tip: Did you know that although Service Worker runs in a separate thread, your request handlers execute entirely on the client? This way you can use the same languages, like TypeScript, third-party libraries, and internal logic to create the mocks you need.

Node.js

How does it work?

There's no such thing as Service Workers in Node.js. Instead, MSW implements a low-level interception algorithm that can utilize the very same request handlers you have for the browser. This blends the boundary between environments, allowing you to focus on your network behaviors.

How is it different?

Usage example

Here's an example of using Mock Service Worker while developing your Express server:

import express from 'express'
import { http, HttpResponse } from 'msw'
import { setupServer } from 'msw/node'

const app = express()
const server = setupServer()

app.get(
  '/checkout/session',
  server.boundary((req, res) => {
    // Describe the network for this Express route.
    server.use(
      http.get(
        'https://api.stripe.com/v1/checkout/sessions/:id',
        ({ params }) => {
          return HttpResponse.json({
            id: params.id,
            mode: 'payment',
            status: 'open',
          })
        },
      ),
    )

    // Continue with processing the checkout session.
    handleSession(req, res)
  }),
)

This example showcases server.boundary() to scope request interception to a particular closure, which is extremely handy!

Sponsors

Mock Service Worker is trusted by hundreds of thousands of engineers around the globe. It's used by companies like Google, Microsoft, Spotify, Amazon, Netflix, and countless others. Despite that, it remains a hobby project maintained in a spare time and has no opportunity to financially support even a single full-time contributor.

You can change that! Consider sponsoring the effort behind one of the most innovative approaches around API mocking. Raise a topic of open source sponsorships with your boss and colleagues. Let's build sustainable open source together!

Golden sponsors

Become our golden sponsor and get featured right here, enjoying other perks like issue prioritization and a personal consulting session with us.

Learn more on our GitHub Sponsors profile.


GitHub Workleap Chromatic
StackBlitz CodeRabbit

Silver sponsors

Become our silver sponsor and get your profile image and link featured right here.

Learn more on our GitHub Sponsors profile.


Replay Codemod Ryan Magoon

Bronze sponsors

Become our bronze sponsor and get your profile image and link featured in this section.

Learn more on our GitHub Sponsors profile.


Materialize Trigger.dev Vital

Awards & mentions

We've been extremely humbled to receive awards and mentions from the community for all the innovation and reach Mock Service Worker brings to the JavaScript ecosystem.

Technology Radar

Solution Worth Pursuing

Technology Radar (2020–2021)

Open Source Awards 2020

The Most Exciting Use of Technology

Open Source Awards (2020)

Special thanks

Thank you to Blacksmith for a x10 faster remote builds.

CI powered by Blacksmith

msw (mswjs/msw)

Searching Database…

18.3K ·GitHub
What is this?Mock Service Worker (MSW) is the industry-standard API mocking library for JavaScript. It intercepts the network requests your app makes and serves mock responses you define, so you never touch a real backend.
Is it a testing framework or a library I use in my app?It's a library you add to a JavaScript project, not a test runner or framework: you write request handlers and register them with setupWorker in the browser or setupServer in Node.js.
How do I add it to my project?The README points to the official documentation and its Quick start guide as the place to begin. In short: install the msw package, write handlers, and register them via setupWorker (browser) or setupServer (Node).
Do I need anything special installed to run it?Node.js 18 or newer per the package engines field. No accounts or hosted services — it's an npm dependency, and graphql ships as a runtime dependency for mocking GraphQL APIs.
Will I have to change my application code to use the mocks?No — requests are intercepted on the network level, after they leave your application, so app code and tests stay unaware of what is mocked. You can even inspect mocked responses in the browser's Network tab.
Who is this for — is it actually production-proven?Frontend and backend JavaScript developers who build or test against APIs. Hundreds of thousands of engineers use it, including teams at Google, Microsoft, Spotify, Amazon, and Netflix.
Does it work only in the browser, or in Node.js too?Both. In the browser it registers a real Service Worker; in Node.js, where Service Workers don't exist, it switches to a low-level interception algorithm — the same request handlers work in both environments.
How do I write a mock — is there a special DSL?No — handlers use an Express-like routing syntax. You match requests with parameters, wildcards, or regular expressions and respond with custom status codes, headers, cookies, delays, or fully custom resolvers.
Can I reuse the same mocks across unit, integration, and E2E tests?Yes, that's a core design goal: one mock definition works for local development, debugging, and unit/integration/E2E testing alike, with no adapters — and your tests stay unaware anything is mocked.
Does it cover GraphQL and WebSocket APIs, or only REST?More than REST: the README's course list covers mocking REST and GraphQL APIs as well as mocking and testing WebSocket APIs, and graphql is a runtime dependency of the package.
Is MSW free to use?Yes — it's MIT-licensed and free. The project runs on GitHub Sponsors with golden, silver, and bronze tiers, and royalties from paid Egghead courses about MSW also help sustain development.
What are similar projects?pollyjs, Mock, nock, mockito, jsdom, hoppscotch, testify, mocha
Creator
mswjs
Size
13.9 MB
Stars
18.3K
Age
7y
Commits · 90 Days