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 标头。默认为无。
- 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