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

APIRequest

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

メソッド​

newContext​

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

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

使用法

await apiRequest.newContext();
await apiRequest.newContext(options);

引数

  • options Object (optional)

    • baseURL string (オプション)#

      apiRequestContext.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になります。

    • clientCertificates Array<Object> (optional)追加されたバージョン: 1.46#

      • origin string

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

      • certPath string (optional)

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

      • cert Buffer (optional)

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

      • keyPath string (optional)

        PEM形式の秘密鍵ファイルへのパス。

      • key Buffer (optional)

        PEM形式の秘密鍵の直接値。

      • pfxPath string (optional)

        PFXまたはPKCS12形式でエンコードされた秘密鍵と証明書チェーンへのパス。

      • pfx Buffer (optional)

        PFXまたはPKCS12形式でエンコードされた秘密鍵と証明書チェーンの直接値。

      • passphrase string (optional)

        秘密鍵（PEMまたはPFX）のパスフレーズ。

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

      詳細

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

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

      注

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

    • extraHTTPHeaders Object<string, string> (オプション)#

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

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

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

    • httpCredentials Object (オプション)#

      • username string

      • password string

      • origin string (optional)

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

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

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

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

    • ignoreHTTPSErrors boolean (オプション)#

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

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

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

    • proxy Object (オプション)#

      • server string

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

      • bypass string (optional)

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

      • username string (optional)

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

      • password string (optional)

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

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

    • storageState string | Object (オプション)#

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

    • timeout number (オプション)#

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

    • userAgent string (オプション)#

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

戻り値