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レスポンスボディのバッファを返します。
使用法
api_response.body()
戻り値
dispose
追加バージョン: v1.16このレスポンスのボディを破棄します。呼び出されない場合、ボディはコンテキストが閉じるまでメモリに残ります。
使用法
api_response.dispose()
戻り値
json
追加バージョン: v1.16レスポンスボディのJSON表現を返します。
このメソッドは、レスポンスボディがJSON.parseで解析できない場合にスローされます。
使用法
api_response.json()
戻り値
text
追加バージョン: v1.16レスポンスボディのテキスト表現を返します。
使用法
api_response.text()
戻り値
プロパティ
headers
追加バージョン: v1.16このレスポンスに関連付けられたすべてのHTTPレスポンスヘッダーを含むオブジェクトです。
使用法
api_response.headers
戻り値
headers_array
追加バージョン: v1.16このレスポンスに関連付けられたすべてのHTTPレスポンスヘッダーの配列です。ヘッダー名は小文字に変換されません。Set-Cookieのように複数のエントリを持つヘッダーは、配列内に複数回出現します。
使用法
api_response.headers_array
戻り値
ok
追加バージョン: v1.16レスポンスが成功したかどうか (ステータスが200-299の範囲) を示すブール値が含まれます。
使用法
api_response.ok
戻り値
status
追加バージョン: v1.16レスポンスのステータスコード (例: 成功の場合は200) が含まれます。
使用法
api_response.status
戻り値
status_text
追加バージョン: v1.16レスポンスのステータステキスト (例: 通常は成功の場合の"OK") が含まれます。
使用法
api_response.status_text
戻り値
url
追加バージョン: v1.16レスポンスのURLが含まれます。
使用法
api_response.url
戻り値