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。示例
  - 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
- 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 标头。默认为无。
- setHttpCredentials HttpCredentials (可选)#
  - setUsername String
  - setPassword String
  - setOrigin String (可选)
    
    限制在特定来源上发送 http 凭据 (scheme://host:port).
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (可选)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，并且不影响从浏览器发送的请求。 'always' - 带有基本身份验证凭据的 Authorization 标头将随每个 API 请求一起发送。 'unauthorized - 仅当收到带有 WWW-Authenticate 标头的 401 (未授权) 响应时才发送凭据。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定来源，则用户名和密码将发送到任何服务器以响应未经授权的响应。
- setIgnoreHTTPSErrors boolean (可选)#
  
  在发送网络请求时是否忽略 HTTPS 错误。默认为 false。
- 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