APIRequest

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

メソッド

NewContextAsync

追加バージョン: v1.16

apiRequest.NewContextAsync

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

使用法

await ApiRequest.NewContextAsync(options);

引数

options ApiRequestNewContextOptions? (オプション)
- BaseURL string? (オプション)#
  
  ApiRequestContext.GetAsync() のようなメソッドは、対応する 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 IEnumerable?<ClientCertificates> (任意)追加されたバージョン: 1.46#
  - Origin string
    
    証明書が有効な正確なオリジン。オリジンにはhttpsプロトコル、ホスト名、オプションでポートが含まれます。
  - CertPath string? (任意)
    
    PEM形式の証明書ファイルへのパス。
  - Cert byte[]? (任意)
    
    PEM形式の証明書の直接値。
  - KeyPath string? (任意)
    
    PEM形式の秘密鍵ファイルへのパス。
  - Key byte[]? (任意)
    
    PEM形式の秘密鍵の直接値。
  - PfxPath string? (任意)
    
    PFXまたはPKCS12形式でエンコードされた秘密鍵と証明書チェーンへのパス。
  - Pfx byte[]? (任意)
    
    PFXまたはPKCS12形式でエンコードされた秘密鍵と証明書チェーンの直接値。
  - Passphrase string? (任意)
    
    秘密鍵（PEMまたはPFX）のパスフレーズ。
  TLSクライアント認証により、サーバーはクライアント証明書を要求し、それを検証できます。
  
  詳細
  
  使用するクライアント証明書の配列。各証明書オブジェクトは、certPathとkeyPathの両方、単一のpfxPath、またはそれらに対応する直接値（certとkey、またはpfx）のいずれかを持っている必要があります。オプションで、証明書が暗号化されている場合はpassphraseプロパティを提供する必要があります。originプロパティは、証明書が有効なリクエストオリジンと正確に一致するように提供する必要があります。
  
  クライアント証明書認証は、少なくとも1つのクライアント証明書が提供された場合にのみ有効になります。サーバーから送信されたすべてのクライアント証明書を拒否したい場合は、訪問する予定のドメインのいずれとも一致しないoriginを持つクライアント証明書を提供する必要があります。
  
  注
  macOSでWebKitを使用している場合、localhostにアクセスしてもクライアント証明書は取得されません。localhostをlocal.playwrightに置き換えることで機能させることができます。
- ExtraHTTPHeaders IDictionary?<string, string> (オプション)#
  
  すべてのリクエストと一緒に送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなし。
- FailOnStatusCode bool? (オプション)追加バージョン: v1.51#
  
  2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。
- HttpCredentials HttpCredentials? (オプション)#
  - Username string
  - Password string
  - Origin string? (任意)
    
    特定のオリジン(scheme://host:port)でのhttp資格情報の送信を制限します:ポート).
  - Send enum HttpCredentialsSend { Unauthorized, Always }? (任意)
    
    このオプションは、対応するAPIRequestContextから送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 各APIリクエストで基本認証資格情報を持つAuthorizationヘッダーが送信されます。'unauthorized' - 資格情報は、WWW-Authenticateヘッダーを持つ401（Unauthorized）応答が受信された場合にのみ送信されます。デフォルトは'unauthorized'です。
  HTTP認証用の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答があった場合にすべてのサーバーに送信されます。
- IgnoreHTTPSErrors bool? (オプション)#
  
  ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- MaxRedirects int? (任意)追加バージョン: v1.52#
  
  自動的に追跡されるリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトを追跡しない場合は 0 を渡します。これは各リクエストで個別に上書きできます。
- Proxy Proxy? (オプション)#
  - 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? (オプション)#
  
  指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.StorageStateAsync() または ApiRequestContext.StorageStateAsync() を介して取得されたログイン情報でコンテキストを初期化するために使用できます。保存されたストレージを含むファイルへのパス、または BrowserContext.StorageStateAsync() または ApiRequestContext.StorageStateAsync() メソッドのいずれかによって返された値。
- StorageStatePath string? (オプション)追加: v1.18#
  
  指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.StorageStateAsync() を介して取得されたログイン情報でコンテキストを初期化するために使用できます。保存されたストレージ状態を含むファイルへのパス。
- Timeout [float]? (オプション)#
  
  レスポンスを待つ最大ミリ秒数。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。
- UserAgent string? (オプション)#
  
  このコンテキストで使用する特定のユーザーエージェント。

戻り値

APIRequestContext #

メソッド​

NewContextAsync​

メソッド

NewContextAsync