APIResponse
APIResponse クラスは、api_request_context.get() および同様のメソッドから返されるレスポンスを表します。
- Sync
- Async
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"
assert response.json()["name"] == "foobar"
assert await response.body() == '{"status": "ok"}'
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
メソッド
body
Added in: v1.16レスポンスボディを持つバッファを返します。
使用例
api_response.body()
戻り値
dispose
Added in: v1.16このレスポンスのボディを破棄します。呼び出されない場合、ボディはコンテキストが閉じるまでメモリに残ります。
使用例
api_response.dispose()
戻り値
json
Added in: v1.16レスポンスボディの JSON 表現を返します。
レスポンスボディが JSON.parse で解析できない場合、このメソッドは例外をスローします。
使用例
api_response.json()
戻り値
text
Added in: v1.16レスポンスボディのテキスト表現を返します。
使用例
api_response.text()
戻り値
プロパティ
headers
Added in: v1.16このレスポンスに関連付けられたすべてのレスポンス HTTP ヘッダーを持つオブジェクト。
使用例
api_response.headers
戻り値
headers_array
Added in: v1.16このレスポンスに関連付けられたすべてのレスポンス HTTP ヘッダーを持つ配列。ヘッダー名は小文字化されていません。 Set-Cookie など、複数のエントリを持つヘッダーは、配列に複数回表示されます。
使用例
api_response.headers_array
戻り値
ok
Added in: v1.16レスポンスが成功した (ステータスが 200-299 の範囲) かどうかを示すブール値を含みます。
使用例
api_response.ok
戻り値
status
Added in: v1.16レスポンスのステータスコード (例: 成功の場合は 200) を含みます。
使用例
api_response.status
戻り値
status_text
Added in: v1.16レスポンスのステータステキスト (例: 通常、成功の場合は "OK") を含みます。
使用例
api_response.status_text
戻り値
url
Added in: v1.16レスポンスの URL を含みます。
使用例
api_response.url
戻り値