跳到主要内容

模拟 API

简介​

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

模拟 API 请求​

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

def test_mock_the_fruit_api(page: Page):
    def handle(route: Route):
        json = [{"name": "Strawberry", "id": 21}]
        # fulfill the route with the mock data
        route.fulfill(json=json)

    # Intercept the route to the fruit API
    page.route("*/**/api/v1/fruits", handle)

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

    # Assert that the Strawberry fruit is visible
    expect(page.get_by_text("Strawberry")).to_be_visible()

您可以从示例测试的跟踪中看到，API 从未被调用，但它已使用模拟数据完成。api mocking trace

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

修改 API 响应​

有时，进行 API 请求是必要的，但需要修补响应以允许可重现的测试。在这种情况下，可以执行请求并使用修改后的响应来完成请求，而不是模拟请求。

在下面的示例中，我们拦截对水果 API 的调用，并将一个名为“Loquat”的新水果添加到数据中。然后，我们转到 url 并断言该数据在那里

def test_gets_the_json_from_api_and_adds_a_new_fruit(page: Page):
    def handle(route: Route):
        response = route.fetch()
        json = response.json()
        json.append({ "name": "Loquat", "id": 100})
        # Fulfill using the original response, while patching the response body
        # with the given JSON object.
        route.fulfill(response=response, json=json)

    page.route("https://demo.playwright.dev/api-mocking/api/v1/fruits", handle)

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

    # Assert that the new fruit is visible
    expect(page.get_by_text("Loquat", exact=True)).to_be_visible()

在我们的测试跟踪中，我们可以看到 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.route_from_har() 或 browser_context.route_from_har() 方法。此方法接受 HAR 文件的路径和一个可选的选项对象。选项对象可以包含 URL，以便只有 URL 与指定的 glob 模式匹配的请求才会从 HAR 文件中提供。如果未指定，则所有请求都将从 HAR 文件中提供。

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

def test_records_or_updates_the_har_file(page: Page):
    # Get the response from the HAR file
    page.route_from_har("./hars/fruit.har", url="*/**/api/v1/fruits", update=True)

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

    # Assert that the fruit is visible
    expect(page.get_by_text("Strawberry")).to_be_visible()

修改 HAR 文件​

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

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

从 HAR 重放​

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

def test_gets_the_json_from_har_and_checks_the_new_fruit_has_been_added(page: Page):
    # Replay API requests from HAR.
    # Either use a matching response from the HAR,
    # or abort the request if nothing matches.
    page.route_from_har("./hars/fruit.har", url="*/**/api/v1/fruits", update=False)

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

    # Assert that the Playwright fruit is visible
    expect(page.get_by_text("Playwright", exact=True)).to_be_visible()

在我们的测试跟踪中，我们可以看到路由是从 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.
playwright open --save-har=example.har --save-har-glob="**/api/**" https://example.com

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

模拟 WebSocket​

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

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "request":
    ws.send("response")

page.route_web_socket("wss://example.com/ws", lambda ws: ws.on_message(
    lambda message: message_handler(ws, message)
))

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

def message_handler(server: WebSocketRoute, message: Union[str, bytes]):
  if message == "request":
    server.send("request2")
  else:
    server.send(message)

def handler(ws: WebSocketRoute):
  server = ws.connect_to_server()
  ws.on_message(lambda message: message_handler(server, message))

page.route_web_socket("wss://example.com/ws", handler)

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