APIRequest

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

方法

newContext

新增于：v1.16

apiRequest.newContext

创建 APIRequestContext 的新实例。

用法

APIRequest.newContext();
APIRequest.newContext(options);

参数

options ApiRequest.NewContextOptions（可选）
- setBaseURL String（可选）#
  
  像 APIRequestContext.get() 这样的方法会通过使用 URL() 构造函数来构建相应的 URL，从而考虑基础 URL。示例：
  - 基础 URL：http://localhost:3000，发送请求到 /bar.html，结果为 http://localhost:3000/bar.html
  - 基础 URL：http://localhost:3000/foo/，发送请求到 ./bar.html，结果为 http://localhost:3000/foo/bar.html
  - 基础 URL：http://localhost:3000/foo（无尾部斜杠），导航到 ./bar.html，结果为 http://localhost:3000/bar.html
- setClientCertificates List<ClientCertificates>（可选）新增于：1.46#
  - setOrigin String
    
    证书适用的精确源。源包括 https 协议、主机名，还可以选择包含端口。
  - setCertPath Path（可选）
    
    PEM 格式证书文件的路径。
  - setCert [byte[]]（可选）
    
    PEM 格式证书的直接值。
  - setKeyPath Path（可选）
    
    PEM 格式私钥文件的路径。
  - setKey [byte[]]（可选）
    
    PEM 格式私钥的直接值。
  - setPfxPath Path（可选）
    
    PFX 或 PKCS12 编码的私钥和证书链文件的路径。
  - setPfx [byte[]]（可选）
    
    PFX 或 PKCS12 编码的私钥和证书链的直接值。
  - setPassphrase String（可选）
    
    私钥（PEM 或 PFX）的密码。
  TLS 客户端身份验证允许服务器请求并验证客户端证书。
  
  详细信息
  
  要使用的客户端证书数组。每个证书对象必须同时具有 certPath 和 keyPath，或者单个 pfxPath，或者它们对应的直接值等效项（cert 和 key，或 pfx）。如果证书已加密，应提供可选的 passphrase 属性。应提供 origin 属性，且其值应与证书适用的请求源完全匹配。
  
  备注
  在 macOS 上使用 WebKit 时，访问 localhost 将不会获取客户端证书。你可以将 localhost 替换为 local.playwright 来解决此问题。
- setExtraHTTPHeaders Map<String, String>（可选）#
  
  一个包含要随每个请求发送的额外 HTTP 标头的对象。默认为无。
- setFailOnStatusCode boolean（可选）新增于：v1.51#
  
  对于非 2xx 和 3xx 的响应代码是否抛出异常。默认情况下，所有状态码都会返回响应对象。
- setHttpCredentials HttpCredentials（可选）#
  - setUsername String
  - setPassword String
  - setOrigin String（可选）
    
    限制在特定源（scheme://host:port）上发送 HTTP 凭据。
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS }（可选）
    
    此选项仅适用于从相应 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 每个 API 请求都将发送带有基本身份验证凭据的 Authorization 标头。'unauthorized - 仅当收到带有 WWW-Authenticate 标头的 401（未授权）响应时才发送凭据。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定源，则在收到未授权响应时，用户名和密码将发送到任何服务器。
- setIgnoreHTTPSErrors boolean（可选）#
  
  发送网络请求时是否忽略 HTTPS 错误。默认为 false。
- setMaxRedirects int（可选）新增于：v1.52#
  
  将自动跟随的请求重定向的最大数量。如果超过此数量，将抛出错误。默认为 20。传递 0 以不跟随重定向。此设置可针对每个请求单独覆盖。
- setProxy Proxy（可选）#
  - setServer String
    
    所有请求要使用的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简短形式 myproxy.com:3128 被视为 HTTP 代理。
  - setBypass String（可选）
    
    可选的以逗号分隔的绕过代理的域名，例如 ".com, chromium.org, .domain.com"。
  - setUsername String（可选）
    
    如果 HTTP 代理需要身份验证，可选的要使用的用户名。
  - setPassword String（可选）
    
    如果 HTTP 代理需要身份验证，可选的要使用的密码。
  网络代理设置。
- setStorageState String（可选）#
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 或 APIRequestContext.storageState() 获取的登录信息来初始化上下文。可以是保存存储的文件路径，也可以是 BrowserContext.storageState() 或 APIRequestContext.storageState() 方法返回的值。
- setStorageStatePath Path（可选）新增于：v1.18#
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 获取的登录信息来初始化上下文。保存存储状态的文件路径。
- setTimeout double（可选）#
  
  等待响应的最长时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。
- setUserAgent String（可选）#
  
  在此上下文中要使用的特定用户代理。

返回值

APIRequestContext #

方法​

newContext​

参数​

方法

newContext

参数