模拟 API

介绍

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

模拟 API 请求

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

// Intercept the route to the fruit API
page.route("https://fruit.ceo/api/breeds/image/random", route -> {
    List<Dictionary<String, Object>> data = new ArrayList<Dictionary<String, Object>>();
    Hashtable<String, Object> dict = new Hashtable<String, Object>();
    dict.put("name", "Strawberry");
    dict.put("id", 21);
    data.add(dict);
  // fulfill the route with the mock data
  route.fulfill(RequestOptions.create().setData(data));
});

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

// Assert that the Strawberry fruit is visible
assertThat(page.getByText("Strawberry")).isVisible();

从示例测试的跟踪信息中可以看到，API 从未被调用，但响应被模拟数据满足了。

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

修改 API 响应

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

在下面的示例中，我们拦截了对水果 API 的调用，并在数据中添加了一个名为 'Loquat' 的新水果。然后我们访问该 url 并断言这些数据存在

page.route("*/**/api/v1/fruits", route -> {
  Response response = route.fetch();
  byte[] json = response.body();
  JsonObject parsed = new Gson().fromJson(new String(json), JsonObject.class);
  parsed.add(new JsonObject().add("name", "Loquat").add("id", 100));
  // Fulfill using the original response, while patching the response body
  // with the given JSON object.
  route.fulfill(new Route.FulfillOptions().setResponse(response).setBody(parsed.toString()));
});

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

// Assert that the Loquat fruit is visible
assertThat(page.getByText("Loquat", new Page.GetByTextOptions().setExact(true))).isVisible();

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

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

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

使用 HAR 文件进行模拟

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

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

录制 HAR 文件

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

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

// Get the response from the HAR file
page.routeFromHAR(Path.of("./hars/fruit.har"), new RouteFromHAROptions()
  .setUrl("*/**/api/v1/fruits")
  .setUpdate(true)
);

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

// Assert that the fruit is visible
assertThat(page.getByText("Strawberry")).isVisible();

修改 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.
page.routeFromHAR(Path.of("./hars/fruit.har"), new RouteFromHAROptions()
  .setUrl("*/**/api/v1/fruits")
  .setUpdate(false)
);

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

// Assert that the Playwright fruit is visible
assertThat(page.getByText("Playwright", new Page.GetByTextOptions()
  .setExact(true))).isVisible();

在我们的测试跟踪信息中，我们可以看到路由是通过 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.
mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="open --save-har=example.har --save-har-glob='**/api/**' https://example.com"

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

模拟 WebSockets

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

page.routeWebSocket("wss://example.com/ws", ws -> {
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      ws.send("response");
  });
});

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

page.routeWebSocket("wss://example.com/ws", ws -> {
  WebSocketRoute server = ws.connectToServer();
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      server.send("request2");
    else
      server.send(frame.text());
  });
});

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