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

APIRequest

Web APIテストに使用できるAPIを公開します。このクラスは、Webリクエストの送信に使用できるAPIRequestContextインスタンスを作成するために使用されます。このクラスのインスタンスは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: https://:3000 に /bar.html へのリクエストを送信すると、https://:3000/bar.html になります。
    • baseURL: https://:3000/foo/ に ./bar.html へのリクエストを送信すると、https://:3000/foo/bar.html になります。
    • baseURL: https://:3000/foo（末尾にスラッシュなし）で./bar.htmlにナビゲートすると、https://: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プロパティは、証明書が有効なリクエストオリジンと正確に一致するように提供する必要があります。

    クライアント証明書認証は、少なくとも1つのクライアント証明書が提供された場合にのみ有効になります。サーバーから送信されたすべてのクライアント証明書を拒否したい場合は、訪問する予定のドメインのいずれとも一致しないoriginを持つクライアント証明書を提供する必要があります。

    注

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

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

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

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

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

  • http_credentials Dict (オプション)#

    • username str

    • password str

    • origin str (オプション)

      特定のオリジン(scheme://host:port)でのhttp資格情報の送信を制限します:ポート).

    • send "unauthorized" | "always" (optional)

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

    HTTP認証用の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答があった場合にすべてのサーバーに送信されます。

  • ignore_https_errors bool (オプション)#

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

  • max_redirects int (オプション)追加バージョン: v1.52#

    自動的に追跡されるリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトを追跡しない場合は 0 を渡します。これは各リクエストで個別に上書きできます。

  • 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 (オプション)#

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

戻り値