RequestOptions
RequestOptions 允许创建要通过 APIRequestContext 发送的表单数据。Playwright 将自动确定请求的内容类型。
context.request().post(
"https://example.com/submit",
RequestOptions.create()
.setQueryParam("page", 1)
.setData("My data"));
上传 HTML 表单数据
FormData 类可用于向服务器发送表单,默认情况下,请求将使用 application/x-www-form-urlencoded
编码
context.request().post("https://example.com/signup", RequestOptions.create().setForm(
FormData.create()
.set("firstName", "John")
.set("lastName", "Doe")));
您还可以将文件作为 HTML 表单的字段发送。数据将使用 multipart/form-data
进行编码
Path path = Paths.get("members.csv");
APIResponse response = context.request().post("https://example.com/upload_members",
RequestOptions.create().setMultipart(FormData.create().set("membersList", path)));
或者,您可以手动构建文件负载
FilePayload filePayload = new FilePayload("members.csv", "text/csv",
"Alice, 33\nJohn, 35\n".getBytes(StandardCharsets.UTF_8));
APIResponse response = context.request().post("https://example.com/upload_members",
RequestOptions.create().setMultipart(FormData.create().set("membersList", filePayload)));
方法
create
新增于: v1.18创建 RequestOptions 的新实例。
用法
RequestOptions.create();
返回
setData
新增于: v1.18设置请求的 POST 数据。
用法
RequestOptions.setData(data);
参数
-
data
String | byte[] | Object#允许设置请求的 POST 数据。如果 data 参数是一个对象,它将被序列化为 JSON 字符串,并且如果未明确设置,
content-type
头部将被设置为application/json
。否则,如果未明确设置,content-type
头部将被设置为application/octet-stream
。
返回
setFailOnStatusCode
新增于: v1.18用法
RequestOptions.setFailOnStatusCode(failOnStatusCode);
参数
返回
setForm
新增于: v1.18提供 FormData 对象,该对象将使用 application/x-www-form-urlencoded
编码序列化为 HTML 表单并作为此请求正文发送。如果指定了此参数,除非明确提供,否则 content-type
头部将被设置为 application/x-www-form-urlencoded
。
用法
RequestOptions.setForm(form);
参数
返回
setHeader
新增于: v1.18为请求设置 HTTP 头部。此头部将应用于获取的请求以及由其发起的任何重定向。
用法
RequestOptions.setHeader(name, value);
参数
返回
setIgnoreHTTPSErrors
新增于: v1.18用法
RequestOptions.setIgnoreHTTPSErrors(ignoreHTTPSErrors);
参数
返回
setMaxRedirects
新增于: v1.26用法
RequestOptions.setMaxRedirects(maxRedirects);
参数
返回
setMaxRetries
新增于: v1.46用法
RequestOptions.setMaxRetries(maxRetries);
参数
返回
setMethod
新增于: v1.18用法
RequestOptions.setMethod(method);
参数
返回
setMultipart
新增于: v1.18提供 FormData 对象,该对象将使用 multipart/form-data
编码序列化为 HTML 表单并作为此请求正文发送。如果指定了此参数,除非明确提供,否则 content-type
头部将被设置为 multipart/form-data
。
用法
RequestOptions.setMultipart(form);
参数
返回
setQueryParam
新增于: v1.18向请求 URL 添加查询参数。
用法
RequestOptions.setQueryParam(name, value);
参数
返回
setTimeout
新增于: v1.18设置请求超时时间(毫秒)。默认为 30000
(30 秒)。传递 0
以禁用超时。
用法
RequestOptions.setTimeout(timeout);
参数
返回