自动化测试工具playwright中文文档-------10.API 测试

最新推荐文章于 2025-07-24 16:33:55 发布
最新推荐文章于 2025-07-24 16:33:55 发布
阅读量701 收藏 15
点赞数 22
CC 4.0 BY-SA版权
分类专栏： 自动化测试工具playwright中文操作文档 文章标签： 自动化 python pytest 测试工具 playwright
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_76646967/article/details/140813918

介绍

Playwright 可以用来访问你的应用程序的 REST API。

有时，你可能希望直接从 Python 向服务器发送请求，而无需加载页面并在其中运行 JavaScript 代码。这在以下情况下可能非常有用：

  1. 测试你的服务器 API。
  2. 在测试中访问 Web 应用程序之前准备服务器端状态。
  3. 在浏览器中执行某些操作后验证服务器端的后置条件。

所有这些都可以通过  APIRequestContext  方法来实现。

以下示例依赖于 pytest-playwright包，该包将 Playwright 夹具添加到 Pytest 测试运行器中。、

编写 API 测试

APIRequestContext 可以通过网络发送各种 HTTP(S) 请求。

以下示例演示了如何使用 Playwright（通过 GitHub API 测试问题创建。测试套件将执行以下操作：

  1. 在运行测试之前创建一个新的仓库。
  2. 创建几个问题并验证服务器状态。
  3. 在运行测试后删除仓库。

配置

GitHub API需要授权，因此我们将为所有测试配置一次令牌。同时，我们还将设置baseURL以简化测试。

import os
from typing import Generator

import pytest
from playwright.sync_api import Playwright, APIRequestContext

GITHUB_API_TOKEN = os.getenv("GITHUB_API_TOKEN")
assert GITHUB_API_TOKEN, "GITHUB_API_TOKEN is not set"


@pytest.fixture(scope="session")
def api_request_context(
    playwright: Playwright,
) -> Generator[APIRequestContext, None, None]:
    headers = {
        # We set this header per GitHub guidelines.
        "Accept": "application/vnd.github.v3+json",
        # Add authorization token to all requests.
        # Assuming personal access token available in the environment.
        "Authorization": f"token {GITHUB_API_TOKEN}",
    }
    request_context = playwright.request.new_context(
        base_url="https://api.github.com", extra_http_headers=headers
    )
    yield request_context
    request_context.dispose()

-> Generator[APIRequestContext, None, None] 指定了一个函数或方法的返回类型是一个生成器（Generator），这个生成器产生（yields）的对象类型是 APIRequestContext。

Generator[T, SendType, ReturnType] 是一个特殊的类型注解，用于表示生成器函数的类型。这里：

  • T 是生成器产生（yields）的值的类型。
  • SendType 是可以通过 send() 方法发送到生成器的值的类型（在 Python 3.3+ 中引入）。如果生成器不需要接收通过 send() 发送的值，则通常为 None。
  • ReturnType 是生成器正常完成时返回的值的类型（通过 return 语句）。如果生成器没有显式地返回任何值（即到达末尾或抛出异常），则默认为 None。

编写测试

现在我们初始化了请求对象，我们可以添加一些将在存储库中创建新问题的测试。

import os
from typing import Generator

import pytest
from playwright.sync_api import Playwright, APIRequestContext

GITHUB_API_TOKEN = os.getenv("GITHUB_API_TOKEN")
assert GITHUB_API_TOKEN, "GITHUB_API_TOKEN is not set"

GITHUB_USER = os.getenv("GITHUB_USER")
assert GITHUB_USER, "GITHUB_USER is not set"

GITHUB_REPO = "test"

# ...

def test_should_create_bug_report(api_request_context: APIRequestContext) -> None:
    data = {
        "title": "[Bug] report 1",
        "body": "Bug description",
    }
    new_issue = api_request_context.post(f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues", data=data)
    assert new_issue.ok

    issues = api_request_context.get(f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues")
    assert issues.ok
    issues_response = issues.json()
    issue = list(filter(lambda issue: issue["title"] == "[Bug] report 1", issues_response))[0]
    assert issue
    assert issue["body"] == "Bug description"

def test_should_create_feature_request(api_request_context: APIRequestContext) -> None:
    data = {
        "title": "[Feature] request 1",
        "body": "Feature description",
    }
    new_issue = api_request_context.post(f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues", data=data)
    assert new_issue.ok

    issues = api_request_context.get(f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues")
    assert issues.ok
    issues_response = issues.json()
    issue = list(filter(lambda issue: issue["title"] == "[Feature] request 1", issues_response))[0]
    assert issue
    assert issue["body"] == "Feature description"

设置和清理

这些测试假设仓库已经存在。你可能希望在运行测试之前创建一个新仓库，并在测试完成后删除它。为此，可以使用一个会话范围的 fixture。在 yield 之前的部分代表所有测试之前的操作，而 yield 之后的部分代表所有测试之后的操作。

# ...
@pytest.fixture(scope="session", autouse=True)
def create_test_repository(
    api_request_context: APIRequestContext,
) -> Generator[None, None, None]:
    # Before all
    new_repo = api_request_context.post("/user/repos", data={"name": GITHUB_REPO})
    assert new_repo.ok
    yield
    # After all
    deleted_repo = api_request_context.delete(f"/repos/{GITHUB_USER}/{GITHUB_REPO}")
    assert deleted_repo.ok

完整的测试示例

下面是API测试的完整示例:

from enum import auto
import os
from typing import Generator

import pytest
from playwright.sync_api import Playwright, Page, APIRequestContext, expect

GITHUB_API_TOKEN = os.getenv("GITHUB_API_TOKEN")
assert GITHUB_API_TOKEN, "GITHUB_API_TOKEN is not set"

GITHUB_USER = os.getenv("GITHUB_USER")
assert GITHUB_USER, "GITHUB_USER is not set"

GITHUB_REPO = "test"


@pytest.fixture(scope="session")
def api_request_context(
    playwright: Playwright,
) -> Generator[APIRequestContext, None, None]:
    headers = {
        # We set this header per GitHub guidelines.
        "Accept": "application/vnd.github.v3+json",
        # Add authorization token to all requests.
        # Assuming personal access token available in the environment.
        "Authorization": f"token {GITHUB_API_TOKEN}",
    }
    request_context = playwright.request.new_context(
        base_url="https://api.github.com", extra_http_headers=headers
    )
    yield request_context
    request_context.dispose()


@pytest.fixture(scope="session", autouse=True)
def create_test_repository(
    api_request_context: APIRequestContext,
) -> Generator[None, None, None]:
    # Before all
    new_repo = api_request_context.post("/user/repos", data={"name": GITHUB_REPO})
    assert new_repo.ok
    yield
    # After all
    deleted_repo = api_request_context.delete(f"/repos/{GITHUB_USER}/{GITHUB_REPO}")
    assert deleted_repo.ok


def test_should_create_bug_report(api_request_context: APIRequestContext) -> None:
    data = {
        "title": "[Bug] report 1",
        "body": "Bug description",
    }
    new_issue = api_request_context.post(
        f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues", data=data
    )
    assert new_issue.ok

    issues = api_request_context.get(f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues")
    assert issues.ok
    issues_response = issues.json()
    issue = list(
        filter(lambda issue: issue["title"] == "[Bug] report 1", issues_response)
    )[0]
    assert issue
    assert issue["body"] == "Bug description"


def test_should_create_feature_request(api_request_context: APIRequestContext) -> None:
    data = {
        "title": "[Feature] request 1",
        "body": "Feature description",
    }
    new_issue = api_request_context.post(
        f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues", data=data
    )
    assert new_issue.ok

    issues = api_request_context.get(f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues")
    assert issues.ok
    issues_response = issues.json()
    issue = list(
        filter(lambda issue: issue["title"] == "[Feature] request 1", issues_response)
    )[0]
    assert issue
    assert issue["body"] == "Feature description"

通过API调用来准备服务器状态

以下测试通过API创建了一个新的issue，然后导航到项目中的所有issue列表，以检查该issue是否出现在列表的顶部。检查是通过 LocatorAssertions进行的。

def test_last_created_issue_should_be_first_in_the_list(api_request_context: APIRequestContext, page: Page) -> None:  
    def create_issue(title: str) -> None:  
        """  
        通过API创建一个新的issue。  
  
        :param title: issue的标题  
        """  
        data = {  
            "title": title,  
            "body": "Feature description",  # issue的正文描述  
        }  
        # 使用API请求上下文向GitHub API发送POST请求来创建issue  
        new_issue = api_request_context.post(  
            f"/repos/{GITHUB_USER}/{GITHUB_REPO}/issues", data=data  
        )  
        # 断言确保请求成功  
        assert new_issue.ok  
  
    # 创建两个新的issue  
    create_issue("[Feature] request 1")  
    create_issue("[Feature] request 2")  
  
    # 使用Playwright的Page对象导航到GitHub上的issue列表页面  
    page.goto(f"https://github.com/{GITHUB_USER}/{GITHUB_REPO}/issues")  
  
    # 使用locator找到第一个issue的链接（这里假设GitHub的DOM结构中有相应的data属性）  
    first_issue = page.locator("a[data-hovercard-type='issue']").first  
  
    # 使用expect断言来检查第一个issue的标题是否为"[Feature] request 2"  
    # 这意味着最后创建的issue应该出现在列表的顶部  
    expect(first_issue).to_have_text("[Feature] request 2")

执行用户操作后检查服务器状态

以下测试通过浏览器用户界面创建一个新的issue，然后通过API检查该issue是否已被创建：

def test_last_created_issue_should_be_on_the_server(api_request_context: APIRequestContext, page: Page) -> None:  
    # 导航到GitHub仓库的issue页面  
    page.goto(f"https://github.com/{GITHUB_USER}/{GITHUB_REPO}/issues")  
    # 点击“New issue”按钮  
    page.locator("text=New issue").click()  
    # 填写issue的标题  
    page.locator("[aria-label='Title']").fill("Bug report 1")  
    # 填写issue的描述  
    page.locator("[aria-label='Comment body']").fill("Bug description")  
    # 点击“Submit new issue”按钮提交issue  
    page.locator("text=Submit new issue").click()  
      
    # 从提交后页面的URL中提取issue的ID  
    issue_id = page.url.split("/")[-1]  
  
    # 使用API请求上下文向GitHub API发送GET请求，检查新创建的issue  
    new_issue = api_request_context.get(f"https://github.com/{GITHUB_USER}/{GITHUB_REPO}/issues/{issue_id}")  
    # 断言确保请求成功  
    assert new_issue.ok  
    # 断言从API返回的issue的标题是否与预期一致  
    assert new_issue.json()["title"] == "Bug report 1"  
    # 断言从API返回的issue的描述是否与预期一致  
    # 注意：由于实际GitHub API返回的body字段可能包含HTML格式化或其他元数据，这里的断言可能需要调整以匹配实际返回的格式  
    assert new_issue.json()["body"] == "Bug description"

重用认证状态

Web应用程序使用基于cookie或基于令牌的认证方式，其中认证状态作为 cookies存储在浏览器中。Playwright 提供了 api_request_context.storage_state() 方法，该方法可用于从已认证的上下文中检索存储状态，并使用该状态创建新的上下文。

存储状态可以在 BrowserContext 和 APIRequestContext之间互换。你可以使用它先通过API调用来登录，然后创建一个包含已有cookie的新上下文。以下代码片段展示了如何从已认证的 APIRequestContext 中检索状态，并使用该状态创建一个新的  BrowserContext。

# 假设你已经创建了一个Playwright实例并命名为playwright  
# 创建一个新的APIRequestContext，并带上HTTP凭证进行登录  
request_context = playwright.request.new_context(http_credentials={"username": "test", "password": "test"})  
# 注意：这里的.get()方法通常不会处理登录流程中的重定向或登录表单，这里只是为了示例  
# 在实际应用中，你可能需要发送POST请求到登录API，并处理可能的重定向  
request_context.get("https://api.example.com/login")  
  
# 保存存储状态到一个变量中  
state = request_context.storage_state()  
  
# 使用保存的存储状态创建一个新的BrowserContext  
context = browser.new_context(storage_state=state)

Python + Playwright（21）：API接口测试
blues_C的博客
04-29 1646
Playwright 是一个强大的自动化框架，不仅可用于浏览器测试，还可以进行 API 测试。本文将探讨如何利用 Playwright 进行有效的 API 测试，涵盖设置、编写测试等内容。A
自动化测试工具playwright中文文档-------1.编写测试
2301_76646967的博客
08-05 1922
Playwright 测试非常简单，它们执行操作，并断言状态是否符合预期。在执行任何操作之前，无需等待任何内容：Playwright 在执行每个操作之前会自动等待一系列可操作性检查通过。此外，在执行检查时也不需要处理竞态条件——Playwright 的断言设计方式能够描述最终需要满足的期望。就这样！这些设计选择允许 Playwright 用户完全忘记他们测试中的不稳定超时和竞态检查。您将学习如何编写第一个测试如何执行操作如何使用断言测试如何在隔离环境中运行如何使用测试钩子。
自动化测试工具playwright中文文档-------6.Pytest 插件参考
2301_76646967的博客
08-08 2126
Playwright 提供了一个 Pytest 插件，用于编写端到端测试。要开始使用它，请参考入门指南。该插件使您能够利用 Pytest 的测试框架功能来组织和运行您的 Playwright 测试，同时享受 Playwright 提供的丰富 API 和功能，以模拟用户在浏览器中的行为。
Python Playwright库详解：从入门到实战
最新发布
Dxy1239310216的博客
07-24 805
Playwright是一个由微软开发的现代化浏览器自动化库，支持通过统一API控制Chromium、Firefox和WebKit三大浏览器引擎。它具有跨浏览器兼容性、自动等待机制、强大网络控制和移动设备模拟等核心特性。安装简单，支持Python 3.7+环境，提供同步/异步双模式操作方式。核心功能包括基础页面操作、多种元素定位策略、网络请求拦截和移动设备模拟等。最佳实践建议使用Pytest框架组织测试，并提供了调试和性能优化技巧。常见问题包括权限设置、元素定位和登录认证等解决方案。Playwright凭借其
Playwright js/ts 中文文档
热门推荐
YumOS的博客
08-01 1万+
Playwright 中文文档 自己在学playwright的时候找资料比较匮乏，就结合词典翻译了入门介绍部分的文档 网址：https://www.yuque.com/docs/share/5471da47-135d-4f09-b039-3b4d82f7bb74?# 《PlayWright 中文文档》
playwright API测试
我们一起进步吧
06-20 772
【代码】playwright API测试。
自动化测试工具playwright中文文档-------26.Mock APIs
2301_76646967的博客
07-07 934
摘要：Playwright提供强大的网络请求模拟功能，支持HTTP/HTTPS请求的拦截、修改和模拟。开发者可以：1) 直接模拟API响应，不调用真实接口；2) 修改真实API响应数据；3) 使用HAR文件记录和重放网络请求。通过page.route()方法可拦截请求并返回自定义响应，而route_from_har()则支持基于预录制的HAR文件进行测试。HAR文件可手动编辑或通过CLI录制，支持精确匹配URL、方法和请求体。这些功能使前端测试不受后端依赖限制，提高测试可靠性和执行速度，特别适用于API未就
Playwright _ API.pdf
10-07
playwright的python版的API接口资料。
自动化测试工具playwright中文文档-------7.开始使用
2301_76646967的博客
08-09 2291
这意味着在Windows平台上，如果你使用的是Python 3.7或更低版本，并且希望使用Playwright，那么你可能需要确保你的代码或Playwright的某些部分能够正确设置事件循环为ProactorEventLoop，以便能够支持异步子进程。不过，请注意，从Python 3.8开始，这通常是自动处理的，因此不需要额外设置。如果这不可行，你可能需要考虑在打包之前手动下载浏览器并将其放置在 Playwright 能够找到的位置，但这通常不是推荐的做法，因为它增加了打包的复杂性和可执行文件的大小。
自动化测试工具playwright中文文档-------3.运行和调试测试
2301_76646967的博客
08-07 1320
您可以运行单个测试、一组测试或所有测试。通过使用--browser标志，可以在一个浏览器或多个浏览器上运行测试。默认情况下，测试以无头模式运行，这意味着在运行测试时不会打开浏览器窗口，结果将在终端中显示。如果您愿意，可以使用--headedCLI 参数以有头模式运行测试。你将学习如何从命令行运行测试如何调试测试运行测试命令行方式要运行你的测试，使用pytest命令。默认情况下，这将在Chromium浏览器上运行你的测试。
《Playwright+Python 自动化测试 》第一章 环境准备与快速开始-上海悠悠.pdf
01-04
【Playwright+Python 自动化测试】环境准备与快速开始 在自动化测试领域，Selenium 曾经是主流选择，但随着技术的发展，其他框架如 Cypress、Puppeteer 和 TestCafe 也逐渐崭露头角。然而，Playwright 作为新兴的...
自动化测试工具playwright中文文档-------14.Chrome 插件
2301_76646967的博客
04-15 966
在 Playwright 中，Chrome 的默认无头模式并不支持 Chrome 扩展。插件仅在以持久化上下文启动的 Chrome/Chromium 浏览器中工作。为了在运行测试时加载扩展，你可以使用测试夹具（fixture）来设置上下文。此外，你还可以动态地检索扩展ID，并使用它来加载和测试例如弹出页面等。模式并不是 Playwright 官方支持的功能，并且可能会导致意外的行为。的 Manifest v2 插件背景页面句柄的代码示例。首先，添加将加载扩展的测试夹具（fixtures）。
最强自动化测试框架Playwright（23）-API测试
seanyang_的博客
08-13 1003
playwright支持进行API测试playwright.request 方法返回APIRequest类型。
微软出品自动化神器【Playwright+Java】系列（八） 之 使用 Playwright进行API接口测试
专研技术结交志同道合的朋友
02-18 817
我喜欢周末是因为，可以做一些我自己喜欢的事。比如我插上耳机，写点东西就能坐上一天，这也许算是属于我自己的一份静谧吧。Playwright+Java入门感觉还是写API测试简单，而且好上手，难道是我错觉吗？有兴趣的同学可以自行尝试！
自动化测试工具playwright中文文档-------19.评估JavaScript
2301_76646967的博客
06-09 952
Playwright脚本与页面脚本运行在不同环境中，通过page.evaluate()实现跨环境交互。该API允许在浏览器上下文中执行JavaScript函数并返回结果，支持传递可序列化值和JSHandle实例。参数传递可通过原始值、数组、对象、句柄等多种方式实现，包括解构语法和混合参数。正确用法需将外部数据作为参数传递给评估函数，否则会导致未定义错误。文中举例说明了获取页面URL、异步请求状态码、元素内容获取等常见用法，并对比了正确与错误的参数传递方式。
Playwright实战：使用Playwright进行API测试
zhangkexin_z的博客
01-08 816
Playwright是由Microsoft开发的一个自动化测试框架，它支持多种编程语言，如JavaScript、Python等。Playwright的主要优势在于其强大的浏览器自动化能力，可以模拟用户的真实操作，如点击、输入、导航等。同时，Playwright还支持无头模式（headless mode），可以在没有图形界面的环境中运行测试，非常适合在CI/CD（持续集成/持续部署）流程中使用。
自动化测试工具playwright中文文档-------0.playwright安装
2301_76646967的博客
08-02 894
Playwright 是专为满足端到端测试需求而创建的。它支持所有现代渲染引擎，包括 Chromium、WebKit 和 Firefox。您可以在 Windows、Linux 和 macOS 上进行测试，无论是本地测试还是在持续集成（CI）环境中，都可以进行无头模式或有头模式测试，并原生支持移动端模拟。Playwright 库可以用作通用的浏览器自动化工具，为同步和异步 Python 提供了一套强大的 API，用于自动化 Web 应用程序。
使用Claude和Playwright MCP进行API 测试
路飞
07-04 384
使用Claude和Playwright MCP进行API 测试
自动化测试工具playwright中文文档-------15.调试测试（Debugging Tests）
2301_76646967的博客
04-16 1223
但是，在Playwright的自动化测试过程中，如果启动了WebKit Inspector，它会干扰Playwright的正常执行流程，因为它会暂停页面的渲染和JavaScript的执行，以便开发者进行检查和调试。这样，当测试执行到断点处时，它会在浏览器中暂停，并且您可以在浏览器的开发者工具中看到一个 playwright 对象，该对象提供了与 Playwright 相关的各种功能，包括访问页面元素、执行页面操作等。要使用浏览器开发者工具调试您的测试，首先需要在您的测试中设置一个断点，以使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值