APIRequest

提供可用于 Web 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。示例：
  - 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）。如果证书已加密，应提供 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) 上发送 HTTP 凭据。
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于从相应 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 每个 API 请求都会发送带有基本认证凭据的 Authorization 头。'unauthorized - 仅当收到带有 WWW-Authenticate 头的 401 (Unauthorized) 响应时才发送凭据。默认为 'unauthorized'。
  HTTP 认证的凭据。如果未指定来源，用户名和密码会在收到未授权响应时发送给任何服务器。
- ignoreHTTPSErrors boolean (可选)#
  
  是否在发送网络请求时忽略 HTTPS 错误。默认为 false。
- maxRedirects number (可选) 添加于: v1.52#
  
  自动跟随的最大请求重定向次数。如果超过此数字将抛出错误。默认为 20。传递 0 表示不跟随重定向。可以为每个请求单独覆盖此设置。
- 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