APIRequest

Web API テストに使用できる API を公開します。このクラスは、Web リクエストの送信に使用できる APIRequestContext インスタンスを作成するために使用されます。このクラスのインスタンスは、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: http://localhost:3000 で /bar.html にリクエストを送信すると、http://localhost:3000/bar.html になります。
  - baseURL: http://localhost:3000/foo/ で ./bar.html にリクエストを送信すると、http://localhost:3000/foo/bar.html になります。
  - baseURL: http://localhost:3000/foo (末尾のスラッシュなし) で ./bar.html にナビゲートすると、http://localhost: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 (オプション)
    
    特定のオリジン (scheme://host:port).
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (オプション)
    
    このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証資格情報を含む Authorization ヘッダーが、各 API リクエストとともに送信されます。'unauthorized' - 資格情報は、WWW-Authenticate ヘッダーを含む 401 (Unauthorized) レスポンスを受信した場合にのみ送信されます。デフォルトは 'unauthorized' です。
  HTTP 認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、認証されていないレスポンスを受信するすべてのサーバーに送信されます。
- setIgnoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストの送信時に HTTPS エラーを無視するかどうか。デフォルトは false です。
- 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