APIRequest

Web API テストに使用できる API を公開します。このクラスは、APIRequestContext インスタンスの作成に使用され、これにより Web リクエストを送信できます。このクラスのインスタンスは、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 プロパティは、証明書が有効なリクエストオリジンと完全に一致するように指定する必要があります。
  
  注意
  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