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

APIRequest

Web API テストに使用できる API を公開します。このクラスは、APIRequestContext インスタンスを作成するために使用され、そのインスタンスは Web リクエストの送信に使用できます。このクラスのインスタンスは、playwright.request を介して取得できます。詳細については、APIRequestContext を参照してください。

メソッド​

new_context​

追加バージョン: v1.16 apiRequest.new_context

APIRequestContext の新しいインスタンスを作成します。

使用例

api_request.new_context()
api_request.new_context(**kwargs)

引数

  • base_url str (オプション)#

    api_request_context.get() のようなメソッドは、対応する URL を構築するために URL() コンストラクタを使用することにより、ベース URL を考慮します。例

    • baseURL: http://localhost:3000 で /bar.html にリクエストを送信すると、http://localhost:3000/bar.html になります。
    • baseURL: http://localhost:3000/foo/ で ./bar.html にリクエストを送信すると、http://localhost:3000/foo/bar.html になります。
    • baseURL: (末尾のスラッシュなしの) http://localhost:3000/foo で ./bar.html にナビゲートすると、http://localhost:3000/bar.html になります。

  • client_certificates List[Dict] (オプション)追加バージョン: 1.46#

    • origin str

      証明書が有効な正確なオリジン。オリジンには、https プロトコル、ホスト名、およびオプションでポートが含まれます。

    • certPath Union[str, pathlib.Path] (オプション)

      PEM 形式の証明書を含むファイルへのパス。

    • cert bytes (オプション)

      PEM 形式の証明書の直接の値。

    • keyPath Union[str, pathlib.Path] (オプション)

      PEM 形式のプライベートキーを含むファイルへのパス。

    • key bytes (オプション)

      PEM 形式のプライベートキーの直接の値。

    • pfxPath Union[str, pathlib.Path] (オプション)

      PFX または PKCS12 エンコードされたプライベートキーと証明書チェーンへのパス。

    • pfx bytes (オプション)

      PFX または PKCS12 エンコードされたプライベートキーと証明書チェーンの直接の値。

    • passphrase str (オプション)

      プライベートキー (PEM または PFX) のパスフレーズ。

    TLS クライアント認証により、サーバーはクライアント証明書を要求して検証できます。

    詳細

    使用するクライアント証明書の配列。各証明書オブジェクトは、certPath と keyPath の両方、単一の pfxPath、またはそれらに対応する直接の値 (cert と key、または pfx) のいずれかを持っている必要があります。オプションで、証明書が暗号化されている場合は、passphrase プロパティを指定する必要があります。origin プロパティは、証明書が有効なリクエストオリジンに正確に一致するように指定する必要があります。

    注意

    macOS で WebKit を使用する場合、localhost にアクセスしてもクライアント証明書は選択されません。localhost を local.playwright に置き換えることで動作させることができます。

  • extra_http_headers Dict[str, str] (オプション)#

    すべてのリクエストとともに送信される追加の HTTP ヘッダーを含むオブジェクト。デフォルトは none です。

  • fail_on_status_code bool (オプション)追加バージョン: v1.51#

    2xx および 3xx 以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。

  • http_credentials Dict (オプション)#

    • username str

    • password str

    • origin str (オプション)

      特定のオリジン (scheme://host:port).

    • send "unauthorized" | "always" (オプション)

      このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証クレデンシャルを含む Authorization ヘッダーが、各 API リクエストとともに送信されます。'unauthorized' - クレデンシャルは、WWW-Authenticate ヘッダーを含む 401 (Unauthorized) レスポンスを受信した場合にのみ送信されます。デフォルトは 'unauthorized' です。

    HTTP 認証のクレデンシャル。オリジンが指定されていない場合、ユーザー名とパスワードは、未承認のレスポンス時に任意のサーバーに送信されます。

  • ignore_https_errors bool (オプション)#

    ネットワークリクエストの送信時に HTTPS エラーを無視するかどうか。デフォルトは false です。

  • proxy Dict (オプション)#

    • server str

      すべてのリクエストに使用されるプロキシ。HTTP および SOCKS プロキシがサポートされています。例: http://myproxy.com:3128 または socks5://myproxy.com:3128。短縮形 myproxy.com:3128 は HTTP プロキシと見なされます。

    • bypass str (オプション)

      プロキシをバイパスするオプションのカンマ区切りドメイン。例: ".com, chromium.org, .domain.com"。

    • username str (オプション)

      HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。

    • password str (オプション)

      HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。

    ネットワークプロキシ設定。

  • storage_state Union[str, pathlib.Path] | Dict (オプション)#

    指定されたストレージ状態でコンテキストを設定します。このオプションは、browser_context.storage_state() または api_request_context.storage_state() を介して取得したログイン情報でコンテキストを初期化するために使用できます。保存されたストレージへのパス、または browser_context.storage_state() または api_request_context.storage_state() メソッドのいずれかによって返される値のいずれかです。

  • timeout float (オプション)#

    レスポンスを待つ最大時間 (ミリ秒単位)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。

  • user_agent str (オプション)#

    このコンテキストで使用する特定のユーザーエージェント。

戻り値