APIResponse

APIResponse 类表示由 api_request_context.get() 及类似方法返回的响应。

同步

from playwright.sync_api import sync_playwright

with sync_playwright() as p:
    context = playwright.request.new_context()
    response = context.get("https://example.com/user/repos")
    assert response.ok
    assert response.status == 200
    assert response.headers["content-type"] == "application/json; charset=utf-8"
    assert response.json()["name"] == "foobar"
    assert response.body() == '{"status": "ok"}'

异步

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    context = await playwright.request.new_context()
    response = await context.get("https://example.com/user/repos")
    assert response.ok
    assert response.status == 200
    assert response.headers["content-type"] == "application/json; charset=utf-8"
    json_data = await response.json()
    assert json_data["name"] == "foobar"
    assert await response.body() == '{"status": "ok"}'


async def main():
    async with async_playwright() as playwright:
        await run(playwright)

asyncio.run(main())

---

方法

body

新增于: v1.16 apiResponse.body

返回包含响应体的缓冲区。

用法

api_response.body()

返回值

• bytes#

---

dispose

新增于: v1.16 apiResponse.dispose

释放该响应的 body。如果不调用此方法，body 会一直保留在内存中直到上下文关闭。

用法

api_response.dispose()

返回值

• NoneType#

---

json

新增于: v1.16 apiResponse.json

返回响应体的 JSON 表示。

如果响应体无法通过 JSON.parse 解析，此方法会抛出异常。

用法

api_response.json()

返回值

• Dict#

---

text

新增于: v1.16 apiResponse.text

返回响应体的文本表示。

用法

api_response.text()

返回值

• str#

---

属性

headers

新增于: v1.16 apiResponse.headers

一个包含该响应所有 HTTP 响应头的对象。

用法

api_response.headers

返回值

• Dict[str, str]#

---

headers_array

新增于: v1.16 apiResponse.headers_array

一个包含该响应所有 HTTP 响应头的数组。头部名称不会被转为小写。对于有多个条目的头部（如 Set-Cookie），会在数组中出现多次。

用法

api_response.headers_array

返回值

• List[Dict]#

  • name str

    头部名称。

  • value str

    头部值。

---

ok

新增于: v1.16 apiResponse.ok

包含一个布尔值，表示响应是否成功（状态码在 200-299 范围内）。

用法

api_response.ok

返回值

• bool#

---

status

新增于: v1.16 apiResponse.status

包含响应的状态码（例如，200 表示成功）。

用法

api_response.status

返回值

• int#

---

status_text

新增于: v1.16 apiResponse.status_text

包含响应的状态文本（例如，成功时通常为 "OK"）。

用法

api_response.status_text

返回值

• str#

---

url

新增于: v1.16 apiResponse.url

包含响应的 URL。

用法

api_response.url

返回值

• str#