APIRequest

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

メソッド

newContext

追加されたバージョン: v1.16

apiRequest.newContext

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

使用方法

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

引数

options Object (オプション)
- 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> (オプション)追加されたバージョン: 1.46#
  - origin string
    
    証明書が有効な正確なオリジン。オリジンにはhttpsプロトコル、ホスト名、オプションでポートが含まれます。
  - certPath string (オプション)
    
    PEM形式の証明書ファイルへのパス。
  - cert Buffer (オプション)
    
    PEM形式の証明書の直接の値。
  - keyPath string (オプション)
    
    PEM形式の秘密鍵ファイルへのパス。
  - key Buffer (オプション)
    
    PEM形式の秘密鍵の直接の値。
  - pfxPath string (オプション)
    
    PFXまたはPKCS12エンコードされた秘密鍵および証明書チェーンへのパス。
  - pfx Buffer (オプション)
    
    PFXまたはPKCS12エンコードされた秘密鍵および証明書チェーンの直接の値。
  - passphrase string (オプション)
    
    秘密鍵 (PEMまたはPFX) のパスフレーズ。
  TLSクライアント認証により、サーバーはクライアント証明書を要求し、それを検証できます。
  
  詳細
  
  使用されるクライアント証明書の配列。各証明書オブジェクトは、certPathとkeyPathの両方、単一のpfxPath、またはそれに対応する直接値 (certとkey、またはpfx) のいずれかを持つ必要があります。オプションで、証明書が暗号化されている場合はpassphraseプロパティを指定する必要があります。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 (オプション)
    
    特定のオリジン (scheme://host:port).
  - send "unauthorized" | "always" (オプション)
    
    このオプションは、対応する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 (オプション)
    
    プロキシをバイパスする、オプションのカンマ区切りドメイン。例: ".com, chromium.org, .domain.com"。
  - username string (オプション)
    
    HTTPプロキシが認証を要求する場合に使用するオプションのユーザー名。
  - password string (オプション)
    
    HTTPプロキシが認証を要求する場合に使用するオプションのパスワード。
  ネットワークプロキシ設定。
- storageState string | Object (オプション)#
  - cookies Array<Object>
    - name string
    - value string
    - domain string
    - path string
    - expires number
      
      Unix時間（秒単位）。
    - httpOnly boolean
    - secure boolean
    - sameSite "Strict" | "Lax" | "None"
  - origins Array<Object>
    - origin string
    - localStorage Array<Object>
      - name string
      - value string
  指定されたストレージ状態をコンテキストに設定します。このオプションは、browserContext.storageState()またはapiRequestContext.storageState()によって取得されたログイン情報でコンテキストを初期化するために使用できます。保存されたストレージを含むファイルへのパス、またはbrowserContext.storageState()またはapiRequestContext.storageState()メソッドのいずれかによって返された値。
- timeout number (オプション)#
  
  レスポンスを待機する最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。
- userAgent string (オプション)#
  
  このコンテキストで使用する特定のユーザーエージェント。

戻り値

Promise<APIRequestContext>#

メソッド​

newContext​

メソッド

newContext