APIRequest

公开可用于 Web API 测试的 API。此类用于创建 APIRequestContext 实例,该实例可用于发送 Web 请求。可以通过 playwright.request 获取此类的实例。有关更多信息,请参阅 APIRequestContext。

• apiRequest.newContext([options])

apiRequest.newContext([options])

Added in: v1.16

• options? <Object>
  • baseURL? <string> 像 apiRequestContext.get(url[, options]) 这样的方法会使用 URL() 构造函数来构建相应的 URL,并将 base 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
  • extraHTTPHeaders? <Object<string, string>> 包含每个请求都要发送的额外 HTTP 头的对象。#
  • httpCredentials? <Object> HTTP 身份验证的凭据。#
    • username <string>
    • password <string>
  • 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> 使用给定的存储状态填充上下文。此选项可用于使用通过 browserContext.storageState([options]) 或 apiRequestContext.storageState([options]) 获得的已登录信息初始化上下文。可以是保存的存储文件的路径,也可以是 browserContext.storageState([options]) 或 apiRequestContext.storageState([options]) 方法之一返回的值。#
    • 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>
  • timeout? <number> 等待响应的最大时间(毫秒)。默认为 30000(30 秒)。传递 0 可禁用超时。#
  • userAgent? <string> 在此上下文中使用的特定用户代理。#
• returns: <Promise<APIRequestContext>>#

创建新的 APIRequestContext 实例。