APIRequest
暴露可用于Web API测试的API。此类用于创建 APIRequestContext 实例,该实例又可用于发送Web请求。此类的实例可通过 Playwright.request() 获取。有关更多信息,请参阅 APIRequestContext。
方法
newContext
添加于:v1.16创建 APIRequestContext 的新实例。
用法
APIRequest.newContext();
APIRequest.newContext(options);
参数
options
ApiRequest.NewContextOptions
(可选)-
诸如 APIRequestContext.get() 之类的方法通过使用
URL()
构造函数构建相应的 URL 来考虑基本 URL。示例- baseURL:
https://:3000
,向/bar.html
发送请求,结果为https://:3000/bar.html
- baseURL:
https://:3000/foo/
,向./bar.html
发送请求,结果为https://:3000/foo/bar.html
- baseURL:
https://:3000/foo
(不带尾部斜杠),导航到./bar.html
,结果为https://:3000/bar.html
- baseURL:
-
setClientCertificates
列表<ClientCertificates> (可选)添加于: 1.46#-
setOrigin
字符串证书有效的精确源。源包括
https
协议、主机名和可选的端口。 -
setCertPath
路径 (可选)PEM 格式证书文件的路径。
-
setCert
字节数组 (可选)PEM 格式证书的直接值。
-
setKeyPath
路径 (可选)PEM 格式私钥文件的路径。
-
setKey
字节数组 (可选)PEM 格式私钥的直接值。
-
setPfxPath
路径 (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
setPfx
字节数组 (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
setPassphrase
字符串 (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时具有
certPath
和keyPath
,或单个pfxPath
,或其相应的直接值等效项(cert
和key
,或pfx
)。可选地,如果证书已加密,则应提供passphrase
属性。应提供origin
属性,并与证书有效请求的来源精确匹配。客户端证书认证仅在至少提供一个客户端证书时才有效。如果您想拒绝服务器发送的所有客户端证书,则需要提供一个
origin
与您计划访问的任何域不匹配的客户端证书。注意在 macOS 上使用 WebKit 时,访问
localhost
将不会选取客户端证书。您可以通过将localhost
替换为local.playwright
来使其工作。 -
-
setExtraHTTPHeaders
映射<字符串, 字符串> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
setFailOnStatusCode
布尔值 (可选)添加于: v1.51#是否在除 2xx 和 3xx 之外的响应码时抛出错误。默认情况下,所有状态码都会返回响应对象。
-
setHttpCredentials
HttpCredentials (可选)#-
setUsername
字符串 -
setPassword
字符串 -
setOrigin
字符串 (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
setSend
枚举 HttpCredentialsSend { UNAUTHORIZED, ALWAYS }
(可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'
-Authorization
标头将包含基本认证凭据,并随每个 API 请求发送。'unauthorized
- 凭据仅在收到带有WWW-Authenticate
标头的 401(未授权)响应时发送。默认为'unauthorized'
。
HTTP 认证的凭据。如果未指定来源,则用户名和密码将在未授权响应时发送到任何服务器。
-
-
setIgnoreHTTPSErrors
布尔值 (可选)#发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
setMaxRedirects
整型 (可选)添加于: v1.52#将自动跟随的最大请求重定向次数。如果超过此数字,将抛出错误。默认为
20
。传递0
则不跟随重定向。这可以针对每个请求单独覆盖。 -
setProxy
代理 (可选)#-
setServer
字符串用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128
或socks5://myproxy.com:3128
。简写形式myproxy.com:3128
被视为 HTTP 代理。 -
setBypass
字符串 (可选)可选的逗号分隔的域以绕过代理,例如
".com, chromium.org, .domain.com"
。 -
setUsername
字符串 (可选)如果 HTTP 代理需要身份验证,则使用的可选用户名。
-
setPassword
字符串 (可选)如果 HTTP 代理需要身份验证,则使用的可选密码。
网络代理设置。
-
-
使用给定的存储状态填充上下文。此选项可用于通过 BrowserContext.storageState() 或 APIRequestContext.storageState() 获取的登录信息初始化上下文。可以是包含已保存存储的文件路径,也可以是 BrowserContext.storageState() 或 APIRequestContext.storageState() 方法之一返回的值。
-
setStorageStatePath
路径 (可选)新增于: v1.18#使用给定的存储状态填充上下文。此选项可用于通过 BrowserContext.storageState() 获取的登录信息初始化上下文。包含已保存存储状态的文件路径。
-
等待响应的最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。 -
此上下文中使用的特定用户代理。
-
返回