msw

MSW 2.0终于来了！🎉 阅读发布说明，请按照迁移指南进行升级。如果在升级过程中有任何问题，请在我们的Discord服务器上联系我们。

我们还录制了迄今为止最全面的MSW介绍。在我们的官方视频课程中学习如何像专业人士一样模拟API：
<a href="https://egghead.io/courses/mock-rest-and-graphql-apis-with-mock-service-worker-8d471ece?af=8mci9b" target="_blank">

<img src="https://yellow-cdn.veclightyear.com/87312a0a/1f604ba8-9078-48e9-bc85-f2ce45517291.png" alt="使用Mock Service Worker模拟REST和GraphQL API" /> </a> <br /> <br /> <p align="center"> <img src="https://yellow-cdn.veclightyear.com/87312a0a/69651e3c-dd26-4d63-ae62-6274c1b68bc2.svg" width="100" alt="Mock Service Worker标志" /> </p> <h1 align="center">Mock Service Worker</h1> <p align="center">Mock Service Worker (MSW) 是一个适用于浏览器和Node.js的无缝REST/GraphQL API模拟库。</p> <p align="center"> <a href="https://www.npmjs.com/package/msw" target="_blank"><img src="https://yellow-cdn.veclightyear.com/87312a0a/3cfaeeae-943b-4097-9ed1-618c9c4c5d06.svg?style=for-the-badge&label=Latest&color=black" alt="包版本" /></a> <a href="https://www.npmjs.com/package/msw" target="_blank"><img src="https://img.shields.io/npm/dm/msw?style=for-the-badge&color=black" alt="每月下载量" /></a> <a href="https://kettanaito.com/discord" target="_blank"><img src="https://img.shields.io/badge/chat-online-green?style=for-the-badge&color=black" alt="Discord服务器" /></a> </p> <br /> <br />

特性

无缝集成。为您提供专用的请求拦截层。使您的应用程序代码和测试不知道是否有模拟。
无偏差。请求相同的生产资源并测试应用程序的实际行为。增强现有API，或在没有API的情况下边设计边使用。
熟悉且强大。使用类似Express的路由语法来拦截请求。使用参数、通配符和正则表达式匹配请求，并以必要的状态码、标头、cookie、延迟或完全自定义的解析器进行响应。

"我发现了MSW，非常兴奋，因为不仅我仍然可以在DevTools中看到模拟的响应，而且这些模拟不必写在Service Worker中，而可以与应用程序的其他部分放在一起。这使得采用变得非常容易。我还可以将其用于测试，这使MSW成为一个巨大的生产力提升工具。"

– Kent C. Dodds

文档

本README将简要介绍该库，但开始使用Mock Service Worker的最佳地点莫过于其官方文档。

示例

查看使用示例列表

浏览器

工作原理

在浏览器中的使用是Mock Service Worker与其他工具的区别所在。利用Service Worker API（可以出于缓存目的拦截请求），Mock Service Worker在网络层面用您的模拟定义响应被拦截的请求。这样，您的应用程序对模拟一无所知。

看看这个关于Mock Service Worker在浏览器中如何工作的快速演示：

有何不同？

该库在网络层面拦截请求，这意味着是在请求已经执行并"离开"您的应用程序之后。因此，您的全部代码都会运行，在模拟时给您更多信心；
想象您的应用程序是一个盒子。市面上的每个API模拟库都会打开您的盒子，移除发出请求的部分，用一个黑盒代替。Mock Service Worker保持您的盒子完整，与生产环境中的一模一样。相反，MSW存在于您的盒子旁边的一个单独的盒子中；
不再需要stub fetch、axios、react-query等；
您可以在单元测试、集成测试和E2E测试中重用相同的模拟定义。我们是否提到过本地开发和调试？没错。所有这些都针对相同的网络描述运行，无需适配器或臃肿的配置。

使用示例

// src/mocks.js
// 1. 导入库。
import { http, HttpResponse } from 'msw'
import { setupWorker } from 'msw/browser'

// 2. 使用请求处理程序描述网络行为。
const worker = setupWorker(
  http.get('https://github.com/octocat', ({ request, params, cookies }) => {
    return HttpResponse.json(
      {
        message: '模拟响应',
      },
      {
        status: 202,
        statusText: '模拟状态',
      },
    )
  }),
)

// 3. 通过启动Service Worker开始请求拦截。
await worker.start()

在您的应用程序中执行 GET https://github.com/octocat 请求将得到一个模拟响应，您可以在浏览器的"Network"选项卡中检查：

Chrome DevTools Network截图，显示请求被模拟

提示： 您知道吗，虽然Service Worker在单独的线程中运行，但您的模拟定义完全在客户端执行？这样，您可以使用相同的语言，如TypeScript、第三方库和内部逻辑来创建所需的模拟。

Node.js

工作原理

Node.js中没有Service Workers。相反，MSW实现了一个低级拦截算法，可以利用与浏览器相同的请求处理程序。这模糊了环境之间的界限，让您可以专注于网络行为。

有何不同？

不会stub fetch、axios等。因此，您的测试对模拟一无所知；
您可以在本地开发、调试以及测试中重用相同的请求处理程序。真正做到了跨所有环境和所有工具的网络行为单一真相来源。

使用示例

看看这个使用React Testing Library和Mock Service Worker的Vitest集成测试示例：

// test/Dashboard.test.js

import React from 'react'
import { http, HttpResponse } from 'msw'
import { setupServer } from 'msw/node'
import { render, screen, waitFor } from '@testing-library/react'
import Dashboard from '../src/components/Dashboard'

const server = setupServer(
  // 使用请求处理程序描述网络行为。
  // 提示：将处理程序移到它们自己的模块中，
  // 并在浏览器和Node.js设置中导入它们！
  http.get('/posts', ({ request, params, cookies }) => {
    return HttpResponse.json([
      {
        id: 'f8dd058f-9006-4174-8d49-e3086bc39c21',
        title: `测试时避免嵌套`,
      },
      {
        id: '8ac96078-6434-4959-80ed-cc834e7fef61',
        title: `我如何在2021年构建现代网站`,
      },
    ])
  }),
)

// 启用请求拦截。
beforeAll(() => server.listen())

// 重置处理程序，以便每个测试都可以修改它们
// 而不影响其他不相关的测试。
afterEach(() => server.resetHandlers())

// 不要忘记在之后清理。
afterAll(() => server.close())

it('显示最近帖子列表', async () => {
  render(<Dashboard />)

  // 🕗 等待帖子请求完成。
  await waitFor(() => {
    expect(
      screen.getByLabelText('正在获取最新帖子...'),
    ).not.toBeInTheDocument()
  })

  // ✅ 断言正确的帖子已加载。
  expect(
    screen.getByRole('link', { name: /测试时避免嵌套/ }),
  ).toBeVisible()

  expect(
    screen.getByRole('link', { name: /我如何在2021年构建现代网站/ }),
  ).toBeVisible()
})