Most of us are familiar with API testing tools like Postman, SoapUI, etc, and API automation libraries like RestAssured and Karate to automate API test cases. A recent entrant in this category is Playwright. The playwright is an Automation Tool provided by Microsoft. It provides cross-browser testing using which we can perform testing on multiple browsers like Chromium, Webkit, Firefox, etc. playwright supports cross-language testing (Java, Node.js, Python, .NET, etc.). However, very few of us know that it can actually do an API Test automation of methods GET, PUT, POST, and DELETE. Let’s see how it can be done.
Can we perform API testing using Playwright?
The playwright provides inbuilt support for API testing that’s why we don’t need any external libraries to handle API. The playwright doesn’t use any browser to call API. It sends requests using Node.js which provides faster execution.
In this tutorial, we will explore basic API methods with the help of Playwright- java. Below are the Four methods.
- GET
- POST
- PUT
- DELETE
Pre-requisite:
To get started with API automation with playwright-java first we need playwright to be installed in your system, to do this we can simply add the following dependency in the pom.xml file.
Along with the playwright, we have to add Testing and JSON dependencies.
<dependency>
<groupId>com.microsoft.playwright</groupId>
<artifactId>playwright</artifactId>
<version>1.23.0</version>
</dependency>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>7.1.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.googlecode.json-simple</groupId>
<artifactId>json-simple</artifactId>
<version>1.1.1</version>
</dependency>
Now let’s see how we can start API automation testing with Playwright-java.
1. GET:
By providing an API endpoint we can read data using a GET request. We must pass a few parameters to get the required data from the API.
We can verify the request by asserting the Response Code. The response code for a successful GET Request is 200. You can also assert a text inside the JSON body response.
For Example, I am using postman here to send a GET request to ” ‘/api/users/4’ endpoint of a sample API URL ‘https://reqres.in’
The below code shows the implementation of the GET method through Playwright.
@Test
public void get() throws IOException, ParseException {
Playwright playwright = Playwright.create();
String BaseURL="https://reqres.in";
Map<String, String> headers = new HashMap<>();
headers.put("content-type", "application/json");
APIRequestContext apiRequestContext= playwright.request().newContext(new APIRequest.NewContextOptions()
.setBaseURL(BaseURL).setExtraHTTPHeaders(headers));
APIResponse response = apiRequestContext.get("/api/users/4");
int responseCode=response.status();
Assert.assertEquals(responseCode,200);
String responseText= response.text();
JSONParser j= new JSONParser();
JSONObject json = (JSONObject) j.parse(responseText);
String responseData= json.get("data").toString();
JSONObject jsonData = (JSONObject) j.parse(responseData);
Assert.assertEquals(jsonData.get("email"),"eve.holt@reqres.in");
Assert.assertEquals(jsonData.get("first_name"), "Eve");
Assert.assertEquals(jsonData.get("last_name"), "Holt");
Assert.assertEquals(jsonData.get("avatar"), "https://reqres.in/img/faces/4-image.jpg");
apiRequestContext.dispose();
playwright.close();
}
To verify the response data we are parsing the response to JSON Object so that we can verify specific key-value pairs.
2. POST:
POST method is used to add a new record via API where we have to pass data as payload ex. first name, last name, etc. The response code for a successful POST Request is 201.
For example, I am sending a POST request to ‘/api/users/’ endpoint with base URL ‘https://reqres.in‘ and the body as given below in the screenshot:
To pass the data payloads to the POST/PUT method, first, we have to create a POJO class which will help to create methods to get and set payloads.
below we have created a POJO class employee which will help to get and set data to both POST and PUT calls.
public class Employee {
// private variables or data members of pojo class
private String email;
private String first_name;
private String last_name;
private String avatar;
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public String getFirstName() {
return first_name;
}
public void setFirstName(String firstName) {
this.first_name = firstName;
}
public String getLastName() {
return last_name;
}
public void setLastName(String lastName) {
this.last_name = lastName;
}
public String getAvatar() {
return avatar;
}
public void setAvatar(String avatar) {
this.avatar = avatar;
}
}The below code will help you with the POST method through Playwright.
@Test
public void post() throws ParseException {
employee employee = new employee();
employee.setEmail("john@reqres.in");
employee.setFirstName("john");
employee.setLastName("Holt");
employee.setAvatar("https://reqres.in/img/faces/4-image.jpg");
Playwright playwright = Playwright.create();
String BaseURL = "https://reqres.in";
Map<String, String> headers = new HashMap<>();
headers.put("content-type", "application/json");
APIRequestContext apiRequestContext = playwright.request().newContext(new APIRequest.NewContextOptions()
.setBaseURL(BaseURL).setExtraHTTPHeaders(headers));
APIResponse response = apiRequestContext.post("/api/users/", RequestOptions.create().setData(employee));
Assert.assertEquals(response.status(),201);
String responseText= response.text();
JSONParser j= new JSONParser();
JSONObject json = (JSONObject) j.parse(responseText);
Assert.assertEquals(json.get("email"), employee.getEmail());
Assert.assertEquals(json.get("first_name"), employee.getFirstName());
Assert.assertEquals(json.get("last_name"), employee.getLastName());
Assert.assertEquals(json.get("avatar"), employee.getAvatar());
apiRequestContext.dispose();
playwright.close();
}3. PUT:
PUT Request is used to update the existing records via the API. we have to pass the data we want to update as a payload ex. first name, last name, etc. The response code for a successful PUT Request is 200.
For example, I am sending a POST request to ‘/api/users/55’ endpoint with the base URL ‘https://reqres.in’ and the body as given below in the screenshot:
The below example shows the implementation of the PUT method. We need to use the above POJO class to pass the data as a payload to the PUT call.
@Test
public void put() throws ParseException {
employee employee = new employee();
employee.setEmail("john@reqres.in");
employee.setFirstName("Harry");
employee.setLastName("Eve");
employee.setAvatar("https://reqres.in/img/faces/4-image.jpg");
Playwright playwright = Playwright.create();
String BaseURL = "https://reqres.in";
Map<String, String> headers = new HashMap<>();
headers.put("content-type", "application/json");
APIRequestContext apiRequestContext = playwright.request().newContext(new APIRequest.NewContextOptions()
.setBaseURL(BaseURL).setExtraHTTPHeaders(headers));
APIResponse response = apiRequestContext.put("/api/users/55", RequestOptions.create().setData(employee));
Assert.assertEquals(response.status(),200);
String responseText= response.text();
JSONParser j= new JSONParser();
JSONObject json = (JSONObject) j.parse(responseText);
Assert.assertEquals(json.get("email"), employee.getEmail());
Assert.assertEquals(json.get("first_name"), employee.getFirstName());
Assert.assertEquals(json.get("last_name"), employee.getLastName());
Assert.assertEquals(json.get("avatar"), employee.getAvatar());
}4 DELETE:
We can delete existing records using the API by using DELETE Request. Ideally, you must have added a record before you delete it. Hence you would need to append an ID to the DELETE URL. To delete the record using API first we need to pass the record URI (Universal Resource Identifier). The response code for a successful DELETE Request is 200.
For example, I am sending a POST request to ‘https://retoolapi.dev’ endpoint with base URL ‘/3njSPM/calc/43’ and the body as given below in the screenshot:
Following is the code for the DELETE method in Playwright
@Test
public void delete() {
Playwright playwright = Playwright.create();
String BaseURL = "https://retoolapi.dev";
APIRequestContext apiRequestContext = playwright.request().newContext(new APIRequest.NewContextOptions()
.setBaseURL(BaseURL));
APIResponse response = apiRequestContext.delete("/3njSPM/calc/40");
int responseCode = response.status();
Assert.assertEquals(responseCode, 200);
Assert.assertEquals(response.statusText(), "OK");
apiRequestContext.dispose();
playwright.close();After performing a DELETE call we can perform a GET call on the same endpoint to verify data is actually deleted. For this GET call, we will get response code 204 as the content is not found.
For Reference: https://playwright.dev/java/docs/api-testing
Conclusion:-
GET, PUT, POST, and DELETE are the basic CRUD API methods used in any Web application. With the help of the inbuilt functionalities of Playwright, API Automation Testing became much easier and faster.
9
Priyanka is an SDET with 2.5+ years of hands-on experience in Manual, Automation, and API testing. The technologies she has worked on include Selenium, Playwright, Cucumber, Appium, Postman, SQL, GitHub, and Java. Also, she is interested in Blog writing and learning new technologies.