APIRequest

公開 API，可用於 Web API 測試。此類別用於建立 APIRequestContext 實例，而該實例又可用於傳送 Web 請求。此類別的實例可透過 playwright.request 取得。有關更多資訊，請參閱 APIRequestContext。

方法

new_context

新增於：v1.16

apiRequest.new_context

建立 APIRequestContext 的新實例。

用法

api_request.new_context()
api_request.new_context(**kwargs)

引數

base_url str （選用）#

諸如 api_request_context.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
client_certificates List[Dict] （選用）新增於：1.46#
- origin str
  
  憑證有效的確切來源。來源包含 https 協定、主機名稱，以及選用的連接埠。
- certPath Union[str, pathlib.Path] （選用）
  
  具有 PEM 格式憑證的檔案路徑。
- cert bytes （選用）
  
  PEM 格式憑證的直接值。
- keyPath Union[str, pathlib.Path] （選用）
  
  具有 PEM 格式私密金鑰的檔案路徑。
- key bytes （選用）
  
  PEM 格式私密金鑰的直接值。
- pfxPath Union[str, pathlib.Path] （選用）
  
  PFX 或 PKCS12 編碼私密金鑰和憑證鏈的路徑。
- pfx bytes （選用）
  
  PFX 或 PKCS12 編碼私密金鑰和憑證鏈的直接值。
- passphrase str （選用）
  
  私密金鑰（PEM 或 PFX）的密碼。
TLS 用戶端驗證允許伺服器請求用戶端憑證並驗證它。

詳細資訊

要使用的用戶端憑證陣列。每個憑證物件都必須同時具有 certPath 和 keyPath、單一 pfxPath，或其對應的直接值等效項（cert 和 key，或 pfx）。或者，如果憑證已加密，則應提供 passphrase 屬性。origin 屬性應提供與憑證有效的請求來源完全相符的項目。

注意
在 macOS 上使用 WebKit 時，存取 localhost 將不會擷取用戶端憑證。您可以將 localhost 取代為 local.playwright 來使其運作。
extra_http_headers Dict[str, str] （選用）#

包含要與每個請求一起傳送的其他 HTTP 標頭的物件。預設為無。
http_credentials Dict （選用）#
- username str
- password str
- origin str （選用）
  
  限制在特定來源上傳送 http 認證 (scheme://host:port).
- send "unauthorized" | "always" （選用）
  
  此選項僅適用於從對應的 APIRequestContext 傳送的請求，且不影響從瀏覽器傳送的請求。'always' - 具有基本驗證認證的 Authorization 標頭將與每個 API 請求一起傳送。'unauthorized - 認證僅在收到具有 WWW-Authenticate 標頭的 401 (未授權) 回應時傳送。預設為 'unauthorized'。
HTTP 驗證的認證。如果未指定來源，則使用者名稱和密碼會在未經授權的回應時傳送至任何伺服器。
ignore_https_errors bool （選用）#

在傳送網路請求時是否忽略 HTTPS 錯誤。預設為 false。
proxy Dict （選用）#
- server str
  
  用於所有請求的 Proxy。支援 HTTP 和 SOCKS Proxy，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。簡短形式 myproxy.com:3128 會被視為 HTTP Proxy。
- bypass str （選用）
  
  選用的逗號分隔網域以略過 Proxy，例如 ".com, chromium.org, .domain.com"。
- username str （選用）
  
  如果 HTTP Proxy 需要驗證，則使用的選用使用者名稱。
- password str （選用）
  
  如果 HTTP Proxy 需要驗證，則使用的選用密碼。
網路 Proxy 設定。
storage_state Union[str, pathlib.Path] | Dict （選用）#
- cookies List[Dict]
  - name str
  - value str
  - domain str
  - path str
  - expires float
    
    Unix 時間，以秒為單位。
  - httpOnly bool
  - secure bool
  - sameSite "Strict" | "Lax" | "None"
- origins List[Dict]
  - origin str
  - localStorage List[Dict]
    - name str
    - value str
使用給定的儲存狀態填入內容。此選項可用於使用透過 browser_context.storage_state() 或 api_request_context.storage_state() 取得的已登入資訊初始化內容。可以是儲存已儲存儲存狀態的檔案路徑，或由 browser_context.storage_state() 或 api_request_context.storage_state() 方法之一傳回的值。
timeout float （選用）#

等待回應的最長時間，以毫秒為單位。預設值為 30000 (30 秒)。傳遞 0 以停用逾時。
user_agent str （選用）#

在此內容中使用的特定使用者代理程式。

傳回

APIRequestContext #

方法​

new_context​

方法

new_context