メインコンテンツへスキップ

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"}'

メソッド

body

追加日: v1.16 apiResponse.body

レスポンスボディを含むバッファを返します。

使用法

api_response.body()

戻り値


dispose

追加日: v1.16 apiResponse.dispose

このレスポンスのボディを破棄します。呼び出されない場合、コンテキストが閉じられるまでボディはメモリ内に残ります。

使用法

api_response.dispose()

戻り値


json

追加日: v1.16 apiResponse.json

レスポンスボディのJSON表現を返します。

このメソッドは、レスポンスボディがJSON.parseで解析できない場合に例外をスローします。

使用法

api_response.json()

戻り値


text

追加日: v1.16 apiResponse.text

レスポンスボディのテキスト表現を返します。

使用法

api_response.text()

戻り値


プロパティ

headers

追加日: v1.16 apiResponse.headers

このレスポンスに関連付けられたすべてのHTTPヘッダーを含むオブジェクト。

使用法

api_response.headers

戻り値


headers_array

追加日: v1.16 apiResponse.headers_array

このレスポンスに関連付けられたすべてのHTTPヘッダーを含む配列。ヘッダー名は小文字化されません。Set-Cookieのように複数のエントリを持つヘッダーは、配列内に複数回現れます。

使用法

api_response.headers_array

戻り値


ok

追加日: v1.16 apiResponse.ok

レスポンスが成功したか(ステータスが200-299の範囲内)、そうでないかを示すブール値を含みます。

使用法

api_response.ok

戻り値


status

追加日: v1.16 apiResponse.status

レスポンスのステータスコード(例: 成功時の200)を含みます。

使用法

api_response.status

戻り値


status_text

追加日: v1.16 apiResponse.status_text

レスポンスのステータステキスト(例: 成功時には通常「OK」)を含みます。

使用法

api_response.status_text

戻り値


url

追加日: v1.16 apiResponse.url

レスポンスのURLを含みます。

使用法

api_response.url

戻り値