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: 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 になります
- 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）のいずれかを持っている必要があります。オプションで、証明書が暗号化されている場合は、パスフレーズプロパティを指定する必要があります。オリジンプロパティは、証明書が有効なリクエストオリジンと正確に一致するように指定する必要があります。
  
  注
  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 です。
- 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