Mock API

简介

Web API 通常作为 HTTP 端点实现。Playwright 提供了 API 来模拟和修改 HTTP 和 HTTPS 网络流量。页面发出的任何请求，包括 XHRs 和 fetch 请求，都可以被跟踪、修改和模拟。使用 Playwright，您还可以使用包含页面发出的多个网络请求的 HAR 文件进行模拟。

模拟 API 请求

以下代码将拦截所有对 */**/api/v1/fruits 的调用，并返回自定义响应。不会向 API 发出任何请求。测试将转到使用模拟路由的 URL，并断言页面上存在模拟数据。

test("mocks a fruit and doesn't call api", async ({ page }) => {
  // Mock the api call before navigating
  await page.route('*/**/api/v1/fruits', async route => {
    const json = [{ name: 'Strawberry', id: 21 }];
    await route.fulfill({ json });
  });
  // Go to the page
  await page.goto('https://demo.playwright.dev/api-mocking');

  // Assert that the Strawberry fruit is visible
  await expect(page.getByText('Strawberry')).toBeVisible();
});

从示例测试的跟踪中可以看出，API 从未被调用，但它已通过模拟数据得到满足。

阅读更多关于 高级网络 的信息。

修改 API 响应

有时，发出 API 请求是必不可少的，但响应需要修补以实现可重现的测试。在这种情况下，可以执行请求并用修改后的响应来满足它，而不是模拟请求。

在下面的示例中，我们拦截了对水果 API 的调用，并向数据中添加了一种名为“枇杷”的新水果。然后我们转到 URL 并断言该数据存在。

test('gets the json from api and adds a new fruit', async ({ page }) => {
  // Get the response and add to it
  await page.route('*/**/api/v1/fruits', async route => {
    const response = await route.fetch();
    const json = await response.json();
    json.push({ name: 'Loquat', id: 100 });
    // Fulfill using the original response, while patching the response body
    // with the given JSON object.
    await route.fulfill({ response, json });
  });

  // Go to the page
  await page.goto('https://demo.playwright.dev/api-mocking');

  // Assert that the new fruit is visible
  await expect(page.getByText('Loquat', { exact: true })).toBeVisible();
});

在我们的测试跟踪中，我们可以看到 API 被调用并且响应被修改。

通过检查响应，我们可以看到我们的新水果已添加到列表中。

阅读更多关于 高级网络 的信息。

使用 HAR 文件进行模拟

HAR 文件是一个 HTTP 存档 文件，其中包含页面加载时发出的所有网络请求的记录。它包含有关请求和响应头、cookie、内容、计时等信息。您可以使用 HAR 文件在测试中模拟网络请求。您需要：

1. 记录 HAR 文件。
2. 将 HAR 文件与测试一起提交。
3. 在测试中使用保存的 HAR 文件路由请求。

记录 HAR 文件

要记录 HAR 文件，我们使用 page.routeFromHAR() 或 browserContext.routeFromHAR() 方法。此方法接受 HAR 文件的路径和可选的选项对象。选项对象可以包含 URL，以便只有与指定全局模式匹配的 URL 的请求才从 HAR 文件中提供。如果未指定，所有请求都将从 HAR 文件中提供。

将 update 选项设置为 true 将创建或更新 HAR 文件，其中包含实际网络信息，而不是从 HAR 文件提供请求。在创建测试以使用真实数据填充 HAR 时使用它。

或者，您也可以在创建浏览器上下文时使用 browser.newContext() 中的 recordHar 选项来记录 HAR 文件。这允许您捕获整个上下文的所有网络流量，直到上下文关闭。

修改 HAR 文件

记录 HAR 文件后，您可以通过打开“hars”文件夹中的哈希 .txt 文件并编辑 JSON 来修改它。此文件应提交到您的源代码管理。每次使用 update: true 运行此测试时，它都会使用 API 的请求更新您的 HAR 文件。

[
  {
    "name": "Playwright",
    "id": 100
  },
  // ... other fruits
]

从 HAR 重播

现在您已经记录并修改了 HAR 文件的模拟数据，它可以在测试中用于提供匹配的响应。为此，只需关闭或简单地删除 update 选项。这将针对 HAR 文件运行测试，而不是调用 API。

test('gets the json from HAR and checks the new fruit has been added', async ({ page }) => {
  // Replay API requests from HAR.
  // Either use a matching response from the HAR,
  // or abort the request if nothing matches.
  await page.routeFromHAR('./hars/fruit.har', {
    url: '*/**/api/v1/fruits',
    update: false,
  });

  // Go to the page
  await page.goto('https://demo.playwright.dev/api-mocking');

  // Assert that the Playwright fruit is visible
  await expect(page.getByText('Playwright', { exact: true })).toBeVisible();
});

在我们的测试跟踪中，我们可以看到路由已从 HAR 文件中满足，并且 API 未被调用。

如果我们检查响应，我们可以看到我们的新水果已添加到 JSON 中，这是通过手动更新 hars 文件夹中的哈希 .txt 文件完成的。

HAR 重播严格匹配 URL 和 HTTP 方法。对于 POST 请求，它还严格匹配 POST 有效负载。如果多个记录匹配一个请求，则选择匹配头最多的那个。导致重定向的条目将自动跟随。

与记录时类似，如果给定的 HAR 文件名以 .zip 结尾，则它被视为包含 HAR 文件以及作为单独条目存储的网络有效负载的存档。您还可以提取此存档，手动编辑有效负载或 HAR 日志，并指向提取的 HAR 文件。所有有效负载都将相对于文件系统上提取的 HAR 文件解析。

使用 CLI 记录 HAR

我们建议使用 update 选项来记录您的测试的 HAR 文件。但是，您也可以使用 Playwright CLI 记录 HAR。

使用 Playwright CLI 打开浏览器，并传递 --save-har 选项以生成 HAR 文件。可选地，使用 --save-har-glob 仅保存您感兴趣的请求，例如 API 端点。如果 HAR 文件名以 .zip 结尾，则工件将作为单独的文件写入，并全部压缩成一个 zip。

# Save API requests from example.com as "example.har" archive.
npx playwright open --save-har=example.har --save-har-glob="**/api/**" https://example.com

阅读更多关于 高级网络 的信息。

模拟 WebSockets

以下代码将拦截 WebSocket 连接并模拟整个 WebSocket 通信，而不是连接到服务器。此示例响应 "request" 并带有一个 "response"。

await page.routeWebSocket('wss://example.com/ws', ws => {
  ws.onMessage(message => {
    if (message === 'request')
      ws.send('response');
  });
});

或者，您可能希望连接到实际服务器，但在中间拦截消息并修改或阻止它们。这是一个修改页面发送给服务器的一些消息，并保持其余消息不变的示例。

await page.routeWebSocket('wss://example.com/ws', ws => {
  const server = ws.connectToServer();
  ws.onMessage(message => {
    if (message === 'request')
      server.send('request2');
    else
      server.send(message);
  });
});

有关更多详细信息，请参阅 WebSocketRoute。