English · Java
Appearance
English · Java
Appearance
The RequestOptions allows to create form data to be sent via APIRequestContext. Playwright will automatically determine content type of the request.
context.request().post(
"https://example.com/submit",
RequestOptions.create()
.setQueryParam("page", 1)
.setData("My data"));Uploading html form data
FormData class can be used to send a form to the server, by default the request will use application/x-www-form-urlencoded encoding:
context.request().post("https://example.com/signup", RequestOptions.create().setForm(
FormData.create()
.set("firstName", "John")
.set("lastName", "Doe")));You can also send files as fields of an html form. The data will be encoded using 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)));Alternatively, you can build the file payload manually:
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)));Creates new instance of RequestOptions.
Returns
RequestOptionsSets the request's post data.
Arguments
data string | Buffer | Serializable
Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and content-type header will be set to application/json if not explicitly set. Otherwise the content-type header will be set to application/octet-stream if not explicitly set.
Returns
RequestOptionsArguments
Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status codes.
Returns
RequestOptionsProvides FormData object that will be serialized as html form using application/x-www-form-urlencoded encoding and sent as this request body. If this parameter is specified content-type header will be set to application/x-www-form-urlencoded unless explicitly provided.
Arguments
Form data to be serialized as html form using application/x-www-form-urlencoded encoding and sent as this request body.
Returns
RequestOptionsSets an HTTP header to the request. This header will apply to the fetched request as well as any redirects initiated by it.
Arguments
Returns
RequestOptionsArguments
Returns
RequestOptionsArguments
Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to 20. Pass 0 to not follow redirects.
Returns
RequestOptionsArguments
Maximum number of times network errors should be retried. Currently only ECONNRESET error is retried. Does not retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to 0 - no retries.
Returns
RequestOptionsChanges the request method (e.g. PUT or POST).
Arguments
Request method, e.g. POST.
Returns
RequestOptionsProvides FormData object that will be serialized as html form using multipart/form-data encoding and sent as this request body. If this parameter is specified content-type header will be set to multipart/form-data unless explicitly provided.
Arguments
Form data to be serialized as html form using multipart/form-data encoding and sent as this request body.
Returns
RequestOptionsAdds a query parameter to the request URL.
Arguments
Returns
RequestOptionsSets request timeout in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Arguments
Returns
RequestOptions