APIRequest

公開可用於 Web API 測試的 API。此類別用於建立 APIRequestContext 實例，而該實例又可用於發送 Web 請求。此類別的實例可以通過 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：https://127.0.0.1:3000，並且發送請求到 /bar.html 會產生 https://127.0.0.1:3000/bar.html
  - baseURL：https://127.0.0.1:3000/foo/，並且發送請求到 ./bar.html 會產生 https://127.0.0.1:3000/foo/bar.html
  - baseURL：https://127.0.0.1:3000/foo（沒有尾部斜線），並且導航到 ./bar.html 會產生 https://127.0.0.1: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）。選填地，如果憑證已加密，則應提供 passphrase 屬性。origin 屬性應提供與憑證有效的請求來源完全匹配的來源。
  
  注意
  當在 macOS 上使用 WebKit 時，訪問 localhost 將不會選取用戶端憑證。您可以通過將 localhost 替換為 local.playwright 來使其工作。
- extraHTTPHeaders Object<string, string> (選填)#
  
  一個包含要與每個請求一起發送的其他 HTTP 標頭的物件。預設為無。
- httpCredentials Object (選填)#
  - username string
  - password string
  - origin string (選填)
    
    限制在特定來源（scheme://host:port).
  - send "unauthorized" | "always" (選填)
    
    此選項僅適用於從相應的 APIRequestContext 發送的請求，並且不影響從瀏覽器發送的請求。'always' - 具有基本身份驗證憑證的 Authorization 標頭將與每個 API 請求一起發送。'unauthorized - 憑證僅在收到帶有 WWW-Authenticate 標頭的 401（未授權）回應時發送。預設為 'unauthorized'。
  HTTP 身份驗證的憑證。如果未指定來源，則使用者名稱和密碼將在未經授權的回應時發送到任何伺服器。
- ignoreHTTPSErrors boolean (選填)#
  
  在發送網路請求時是否忽略 HTTPS 錯誤。預設為 false。
- proxy Object (選填)#
  - server string
    
    用於所有請求的 Proxy。支援 HTTP 和 SOCKS Proxy，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。簡短形式 myproxy.com:3128 被視為 HTTP Proxy。
  - bypass string (選填)
    
    選填的逗號分隔網域以繞過 Proxy，例如 ".com, chromium.org, .domain.com"。
  - username string (選填)
    
    如果 HTTP Proxy 需要身份驗證，則使用的選填使用者名稱。
  - password string (選填)
    
    如果 HTTP Proxy 需要身份驗證，則使用的選填密碼。
  網路 Proxy 設定。
- 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