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

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プロパティは、証明書が有効なリクエストオリジンと正確に一致するように提供する必要があります。

    注記

    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).

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

      このオプションは、対応するAPIRequestContextから送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 各APIリクエストとともにBasic認証の資格情報を含むAuthorizationヘッダーが送信されます。'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 (オプション)#

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

戻り値