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プロパティは、証明書が有効なリクエストオリジンと完全に一致するように提供する必要があります。
  
  注
  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 (省略可能)
    
    特定のオリジン（スキーム://ホスト）でのHTTP資格情報の送信を抑制する:ポート).
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (省略可能)
    
    このオプションは、対応するAPIRequestContextから送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証クレデンシャルを含むAuthorizationヘッダーが各APIリクエストとともに送信されます。'unauthorized' - クレデンシャルは、WWW-Authenticateヘッダーを含む401（未認証）レスポンスが受信された場合にのみ送信されます。デフォルトは'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 #

メソッド​

newContext​

メソッド

newContext