跳转到主要内容

Mock API

简介​

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

模拟 API 请求​

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

// Intercept the route to the fruit API
await page.RouteAsync("*/**/api/v1/fruits", async route => {
  var json = new[] { new { name = "Strawberry", id = 21 } };
  // fulfill the route with the mock data
  await route.FulfillAsync(new()
  {
    Json = json
  });
});

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

// Assert that the Strawberry fruit is visible
await Expect(page.GetByTextAsync("Strawberry")).ToBeVisibleAsync();

从示例测试的跟踪中可以看出，API 从未被调用，但却被模拟数据填充了。api mocking trace

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

修改 API 响应​

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

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

await page.RouteAsync("*/**/api/v1/fruits", async (route) => {
    var response = await route.FetchAsync();
    var fruits = await response.JsonAsync<Fruit[]>();
    fruits.Add(new Fruit() { Name = "Loquat", Id = 100 });
    // Fulfill using the original response, while patching the response body
    // with the given JSON object.
    await route.FulfillAsync(new ()
    {
      Response = response,
      Json = fruits
    });
  }
);
// Go to the page
await page.GotoAsync("https://demo.playwright.dev/api-mocking");

// Assert that the Loquat fruit is visible
await Expect(page.GetByTextAsync("Loquat", new () { Exact = true })).ToBeVisibleAsync();

在我们的测试跟踪中，我们可以看到 API 被调用，并且响应被修改了。trace of test showing api being called and fulfilled

通过检查响应，我们可以看到新的水果已添加到列表中。trace of test showing the mock response

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

使用 HAR 文件进行模拟​

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

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

记录 HAR 文件​

要录制 HAR 文件，我们使用 Page.RouteFromHARAsync() 或 BrowserContext.RouteFromHARAsync() 方法。此方法接受 HAR 文件的路径和可选的选项对象。选项对象可以包含 URL，这样只有与指定 glob 模式匹配的 URL 的请求才会从 HAR 文件中提供。如果未指定，所有请求都将从 HAR 文件中提供。

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

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

// Get the response from the HAR file
await page.RouteFromHARAsync("./hars/fruit.har", new () {
  Url = "*/**/api/v1/fruits",
  Update = true,
});

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

// Assert that the fruit is visible
await Expect(page.GetByText("Strawberry")).ToBeVisibleAsync();

修改 HAR 文件​

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

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

从 HAR 重播​

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

// Replay API requests from HAR.
// Either use a matching response from the HAR,
// or abort the request if nothing matches.
await page.RouteFromHARAsync("./hars/fruit.har", new ()
  {
    Url = "*/**/api/v1/fruits",
    Update = false,
  }
);

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

// Assert that the Playwright fruit is visible
await page.ExpectByTextAsync("Playwright", new() { Exact = true }).ToBeVisibleAsync();

在我们的测试跟踪中，我们可以看到路由是从 HAR 文件中实现的，并且 API 没有被调用。trace showing the HAR file being used

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

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.
pwsh bin/Debug/netX/playwright.ps1 open --save-har=example.har --save-har-glob="**/api/**" https://example.com

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

模拟 WebSockets​

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

await page.RouteWebSocketAsync("wss://example.com/ws", ws => {
  ws.OnMessage(frame => {
    if (frame.Text == "request")
      ws.Send("response");
  });
});

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

await page.RouteWebSocketAsync("wss://example.com/ws", ws => {
  var server = ws.ConnectToServer();
  ws.OnMessage(frame => {
    if (frame.Text == "request")
      server.Send("request2");
    else
      server.Send(frame.Text);
  });
});

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