APIRequest

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

---

メソッド

newContext

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

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

使用法

APIRequest.newContext();
APIRequest.newContext(options);

引数

• options ApiRequest.NewContextOptions (オプション)

  • setBaseURL 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になります。

  • setClientCertificates List<ClientCertificates> (オプション)追加されたバージョン: 1.46#

    • setOrigin String

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

    • setCertPath Path (オプション)

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

    • setCert byte[] (オプション)

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

    • setKeyPath Path (オプション)

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

    • setKey byte[] (オプション)

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

    • setPfxPath Path (オプション)

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

    • setPfx byte[] (オプション)

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

    • setPassphrase String (オプション)

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

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

    詳細

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

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

    注

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

  • setExtraHTTPHeaders Map<String, String> (オプション)#

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

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

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

  • setHttpCredentials HttpCredentials (オプション)#

    • setUsername String

    • setPassword String

    • setOrigin String (オプション)

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

    • setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (オプション)

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

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

  • setIgnoreHTTPSErrors boolean (オプション)#

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

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

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

  • setProxy Proxy (オプション)#

    • setServer String

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

    • setBypass String (オプション)

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

    • setUsername String (オプション)

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

    • setPassword String (オプション)

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

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

  • setStorageState String (オプション)#

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

  • setStorageStatePath Path (オプション)追加: v1.18#

    指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.storageState() で取得したログイン情報でコンテキストを初期化するために使用できます。保存されたストレージ状態を含むファイルへのパス。

  • setTimeout double (オプション)#

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

  • setUserAgent String (オプション)#

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

戻り値

• APIRequestContext#