Package com.microsoft.playwright

Interface APIRequestContext

public interface APIRequestContext

This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare environment or the service to your e2e test.

Each Playwright browser context has associated with it APIRequestContext instance which shares cookie storage with the browser context and can be accessed via BrowserContext.request() or Page.request(). It is also possible to create a new APIRequestContext instance manually by calling APIRequest.newContext().

Cookie management

APIRequestContext returned by BrowserContext.request() and Page.request() shares cookie storage with the corresponding BrowserContext. Each API request will have Cookie header populated with the values from the browser context. If the API response contains Set-Cookie header it will automatically update BrowserContext cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be logged in and vice versa.

If you want API requests to not interfere with the browser cookies you should create a new APIRequestContext by calling APIRequest.newContext(). Such APIRequestContext object will have its own isolated cookie storage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	APIRequestContext.DisposeOptions
static class	APIRequestContext.StorageStateOptions

Method Summary

Modifier and Type	Method	Description
default APIResponse	delete(String url)	Sends HTTP(S) DELETE request and returns its response.
APIResponse	delete(String url, RequestOptions params)	Sends HTTP(S) DELETE request and returns its response.
default void	dispose()	All responses returned by APIRequestContext.get() and similar methods are stored in the memory, so that you can later call APIResponse.body().This method discards all its resources, calling any method on disposed APIRequestContext will throw an exception.
void	dispose(APIRequestContext.DisposeOptions options)	All responses returned by APIRequestContext.get() and similar methods are stored in the memory, so that you can later call APIResponse.body().This method discards all its resources, calling any method on disposed APIRequestContext will throw an exception.
default APIResponse	fetch(Request urlOrRequest)	Sends HTTP(S) request and returns its response.
APIResponse	fetch(Request urlOrRequest, RequestOptions params)	Sends HTTP(S) request and returns its response.
default APIResponse	fetch(String urlOrRequest)	Sends HTTP(S) request and returns its response.
APIResponse	fetch(String urlOrRequest, RequestOptions params)	Sends HTTP(S) request and returns its response.
default APIResponse	get(String url)	Sends HTTP(S) GET request and returns its response.
APIResponse	get(String url, RequestOptions params)	Sends HTTP(S) GET request and returns its response.
default APIResponse	head(String url)	Sends HTTP(S) HEAD request and returns its response.
APIResponse	head(String url, RequestOptions params)	Sends HTTP(S) HEAD request and returns its response.
default APIResponse	patch(String url)	Sends HTTP(S) PATCH request and returns its response.
APIResponse	patch(String url, RequestOptions params)	Sends HTTP(S) PATCH request and returns its response.
default APIResponse	post(String url)	Sends HTTP(S) POST request and returns its response.
APIResponse	post(String url, RequestOptions params)	Sends HTTP(S) POST request and returns its response.
default APIResponse	put(String url)	Sends HTTP(S) PUT request and returns its response.
APIResponse	put(String url, RequestOptions params)	Sends HTTP(S) PUT request and returns its response.
default String	storageState()	Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.
String	storageState(APIRequestContext.StorageStateOptions options)	Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

Method Detail

delete

default APIResponse delete(String url)

Sends HTTP(S) DELETE request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

Since:

v1.16

delete

APIResponse delete(String url,
                   RequestOptions params)

Sends HTTP(S) DELETE request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

params - Optional request parameters.

Since:

v1.16

dispose

default void dispose()

All responses returned by APIRequestContext.get() and similar methods are stored in the memory, so that you can later call APIResponse.body().This method discards all its resources, calling any method on disposed APIRequestContext will throw an exception.

Since:

v1.16

dispose

void dispose(APIRequestContext.DisposeOptions options)

All responses returned by APIRequestContext.get() and similar methods are stored in the memory, so that you can later call APIResponse.body().This method discards all its resources, calling any method on disposed APIRequestContext will throw an exception.

Since:

v1.16

fetch

default APIResponse fetch(String urlOrRequest)

Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

 Map<String, Object> data = new HashMap();
 data.put("title", "Book Title");
 data.put("body", "John Doe");
 request.fetch("https://example.com/api/createBook", RequestOptions.create().setMethod("post").setData(data));
 

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

 // Pass file path to the form data constructor:
 Path file = Paths.get("team.csv");
 APIResponse response = request.fetch("https://example.com/api/uploadTeamList",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", file)));

 // Or you can pass the file content directly as FilePayload object:
 FilePayload filePayload = new FilePayload("f.js", "text/javascript",
       "console.log(2022);".getBytes(StandardCharsets.UTF_8));
 APIResponse response = request.fetch("https://example.com/api/uploadScript",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", filePayload)));
 

Parameters:

urlOrRequest - Target URL or Request to get all parameters from.

Since:

v1.16

fetch

APIResponse fetch(String urlOrRequest,
                  RequestOptions params)

Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

 Map<String, Object> data = new HashMap();
 data.put("title", "Book Title");
 data.put("body", "John Doe");
 request.fetch("https://example.com/api/createBook", RequestOptions.create().setMethod("post").setData(data));
 

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

 // Pass file path to the form data constructor:
 Path file = Paths.get("team.csv");
 APIResponse response = request.fetch("https://example.com/api/uploadTeamList",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", file)));

 // Or you can pass the file content directly as FilePayload object:
 FilePayload filePayload = new FilePayload("f.js", "text/javascript",
       "console.log(2022);".getBytes(StandardCharsets.UTF_8));
 APIResponse response = request.fetch("https://example.com/api/uploadScript",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", filePayload)));
 

Parameters:

urlOrRequest - Target URL or Request to get all parameters from.

params - Optional request parameters.

Since:

v1.16

fetch

default APIResponse fetch(Request urlOrRequest)

Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

 Map<String, Object> data = new HashMap();
 data.put("title", "Book Title");
 data.put("body", "John Doe");
 request.fetch("https://example.com/api/createBook", RequestOptions.create().setMethod("post").setData(data));
 

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

 // Pass file path to the form data constructor:
 Path file = Paths.get("team.csv");
 APIResponse response = request.fetch("https://example.com/api/uploadTeamList",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", file)));

 // Or you can pass the file content directly as FilePayload object:
 FilePayload filePayload = new FilePayload("f.js", "text/javascript",
       "console.log(2022);".getBytes(StandardCharsets.UTF_8));
 APIResponse response = request.fetch("https://example.com/api/uploadScript",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", filePayload)));
 

Parameters:

urlOrRequest - Target URL or Request to get all parameters from.

Since:

v1.16

fetch

APIResponse fetch(Request urlOrRequest,
                  RequestOptions params)

Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

 Map<String, Object> data = new HashMap();
 data.put("title", "Book Title");
 data.put("body", "John Doe");
 request.fetch("https://example.com/api/createBook", RequestOptions.create().setMethod("post").setData(data));
 

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

 // Pass file path to the form data constructor:
 Path file = Paths.get("team.csv");
 APIResponse response = request.fetch("https://example.com/api/uploadTeamList",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", file)));

 // Or you can pass the file content directly as FilePayload object:
 FilePayload filePayload = new FilePayload("f.js", "text/javascript",
       "console.log(2022);".getBytes(StandardCharsets.UTF_8));
 APIResponse response = request.fetch("https://example.com/api/uploadScript",
   RequestOptions.create().setMethod("post").setMultipart(
     FormData.create().set("fileField", filePayload)));
 

Parameters:

urlOrRequest - Target URL or Request to get all parameters from.

params - Optional request parameters.

Since:

v1.16

get

default APIResponse get(String url)

Sends HTTP(S) GET request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

Request parameters can be configured with params option, they will be serialized into the URL search parameters:

 request.get("https://example.com/api/getText", RequestOptions.create()
   .setQueryParam("isbn", "1234")
   .setQueryParam("page", 23));
 

Parameters:

url - Target URL.

Since:

v1.16

get

APIResponse get(String url,
                RequestOptions params)

Sends HTTP(S) GET request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

Request parameters can be configured with params option, they will be serialized into the URL search parameters:

 request.get("https://example.com/api/getText", RequestOptions.create()
   .setQueryParam("isbn", "1234")
   .setQueryParam("page", 23));
 

Parameters:

url - Target URL.

params - Optional request parameters.

Since:

v1.16

head

default APIResponse head(String url)

Sends HTTP(S) HEAD request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

Since:

v1.16

head

APIResponse head(String url,
                 RequestOptions params)

Sends HTTP(S) HEAD request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

params - Optional request parameters.

Since:

v1.16

patch

default APIResponse patch(String url)

Sends HTTP(S) PATCH request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

Since:

v1.16

patch

APIResponse patch(String url,
                  RequestOptions params)

Sends HTTP(S) PATCH request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

params - Optional request parameters.

Since:

v1.16

post

default APIResponse post(String url)

Sends HTTP(S) POST request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

 Map<String, Object> data = new HashMap();
 data.put("title", "Book Title");
 data.put("body", "John Doe");
 request.post("https://example.com/api/createBook", RequestOptions.create().setData(data));
 

To send form data to the server use form option. Its value will be encoded into the request body with application/x-www-form-urlencoded encoding (see below how to use multipart/form-data form encoding to send files):

 request.post("https://example.com/api/findBook", RequestOptions.create().setForm(
     FormData.create().set("title", "Book Title").set("body", "John Doe")
 ));
 

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

 // Pass file path to the form data constructor:
 Path file = Paths.get("team.csv");
 APIResponse response = request.post("https://example.com/api/uploadTeamList",
   RequestOptions.create().setMultipart(
     FormData.create().set("fileField", file)));

 // Or you can pass the file content directly as FilePayload object:
 FilePayload filePayload1 = new FilePayload("f1.js", "text/javascript",
       "console.log(2022);".getBytes(StandardCharsets.UTF_8));
 APIResponse response = request.post("https://example.com/api/uploadScript",
   RequestOptions.create().setMultipart(
     FormData.create().set("fileField", filePayload)));
 

Parameters:

url - Target URL.

Since:

v1.16

post

APIResponse post(String url,
                 RequestOptions params)

Sends HTTP(S) POST request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

 Map<String, Object> data = new HashMap();
 data.put("title", "Book Title");
 data.put("body", "John Doe");
 request.post("https://example.com/api/createBook", RequestOptions.create().setData(data));
 

To send form data to the server use form option. Its value will be encoded into the request body with application/x-www-form-urlencoded encoding (see below how to use multipart/form-data form encoding to send files):

 request.post("https://example.com/api/findBook", RequestOptions.create().setForm(
     FormData.create().set("title", "Book Title").set("body", "John Doe")
 ));
 

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

 // Pass file path to the form data constructor:
 Path file = Paths.get("team.csv");
 APIResponse response = request.post("https://example.com/api/uploadTeamList",
   RequestOptions.create().setMultipart(
     FormData.create().set("fileField", file)));

 // Or you can pass the file content directly as FilePayload object:
 FilePayload filePayload1 = new FilePayload("f1.js", "text/javascript",
       "console.log(2022);".getBytes(StandardCharsets.UTF_8));
 APIResponse response = request.post("https://example.com/api/uploadScript",
   RequestOptions.create().setMultipart(
     FormData.create().set("fileField", filePayload)));
 

Parameters:

url - Target URL.

params - Optional request parameters.

Since:

v1.16

put

default APIResponse put(String url)

Sends HTTP(S) PUT request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

Since:

v1.16

put

APIResponse put(String url,
                RequestOptions params)

Sends HTTP(S) PUT request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

Parameters:

url - Target URL.

params - Optional request parameters.

Since:

v1.16

storageState

default String storageState()

Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

Since:

v1.16

storageState

String storageState(APIRequestContext.StorageStateOptions options)

Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

Since:

v1.16