APIRequest

暴露可用于Web API测试的API。该类用于创建APIRequestContext实例，该实例又可用于发送Web请求。可以通过playwright.request获取此类的实例。更多信息请参阅APIRequestContext。

方法

new_context

Added in: v1.16

apiRequest.new_context

用法

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

参数

base_url str (可选)#

像api_request_context.get()这样的方法会通过使用URL()构造函数来构建相应的URL，同时考虑基础URL。示例：
- baseURL: http://localhost:3000 and sending request to /bar.html results in http://localhost:3000/bar.html
- baseURL: http://localhost:3000/foo/ and sending request to ./bar.html results in http://localhost:3000/foo/bar.html
- baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost: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属性应提供与证书适用的请求来源完全匹配的值。

note
在macOS上使用WebKit时，访问localhost将无法获取客户端证书。您可以通过将localhost替换为local.playwright来解决此问题。
extra_http_headers Dict[str, str] (可选)#

一个包含要随每个请求发送的额外HTTP头的对象。默认为无。
fail_on_status_code bool (可选) 添加于: v1.51 #

是否在响应状态码不是2xx和3xx时抛出异常。默认情况下会返回所有状态码的响应对象。
http_credentials Dict (可选)#
- username str
- password str
- origin str (可选)
  
  限制在特定来源(scheme://host:port)上发送http凭据。
- send "unauthorized" | "always" (可选)
  
  此选项仅适用于从对应APIRequestContext发送的请求，不会影响从浏览器发送的请求。'always' - 每个API请求都会附带包含基本认证凭据的Authorization头部。'unauthorized - 仅当收到带有WWW-Authenticate头部的401(未授权)响应时才发送凭据。默认为'unauthorized'。
HTTP认证的凭据。如果未指定来源，则在收到未经授权的响应时，用户名和密码将被发送到任何服务器。
ignore_https_errors bool (可选)#

发送网络请求时是否忽略HTTPS错误。默认为false。
proxy Dict (可选)#
- server str
  
  用于所有请求的代理。支持HTTP和SOCKS代理，例如http://myproxy.com:3128或socks5://myproxy.com:3128。短格式myproxy.com:3128被视为HTTP代理。
- bypass str (可选)
  
  可选的逗号分隔域名以绕过代理，例如 ".com, chromium.org, .domain.com"。
- username str (可选)
  
  如果HTTP代理需要认证时可选的用户名。
- password str (可选)
  
  如果HTTP代理需要认证时使用的可选密码。
网络代理设置。
storage_state Union[str, pathlib.Path] | Dict (可选)#
- cookies 列表[字典]
  - name str
  - value str
  - domain str
  - path str
  - expires float
    
    Unix时间戳（秒）。
  - httpOnly bool
  - secure bool
  - sameSite "Strict" | "Lax" | "None"
- origins 列表[字典]
  - 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