How to Test DELETE API By Playwright

  

To test a DELETE API using Playwright in Java, you can use Playwright’s ability to perform raw HTTP requests using the APIRequestContext interface.

What is a DELETE API?

A DELETE API request is typically used to remove a resource from the server. The request usually has:

• An endpoint (example: https://api.example.com/users/123)

• An HTTP method: DELETE

• Sometimes headers (like authorization)

Steps to Test DELETE API in Playwright Java

• Create Playwright and APIRequestContext instance
• Send DELETE request using delete() method
• Validate response (status code, body, etc.)
• Close the context and playwright

Maven Dependencies

<dependency>
    <groupId>com.microsoft.playwright</groupId>
    <artifactId>playwright</artifactId>
    <version>1.44.0</version>
</dependency>

Java Code Example to Test DELETE API

import com.microsoft.playwright.*;

import java.util.HashMap;
import java.util.Map;

public class DeleteAPITest {
    public static void main(String[] args) {
        try (Playwright playwright = Playwright.create()) {
            // Set up base URL and headers
            APIRequest.NewContextOptions options = new APIRequest.NewContextOptions()
                .setBaseURL("https://reqres.in") // Example DELETE test API
                .setExtraHTTPHeaders(Map.of(
                    "Content-Type", "application/json"
                ));

            APIRequestContext request = playwright.request().newContext(options);

            // Send DELETE request
            APIResponse response = request.delete("/api/users/2");

            // Print and assert the response
            System.out.println("Status Code: " + response.status());
            System.out.println("Status Text: " + response.statusText());

            if (response.status() == 204) {
                System.out.println("✅ DELETE API test passed");
            } else {
                System.out.println("❌ DELETE API test failed");
            }

            request.close();
        }
    }
}

Explanation

• setBaseURL("https://reqres.in") sets the base URL.

• .delete("/api/users/2") sends the DELETE request to delete user with ID 2.

• The expected status code is 204 No Content — common for successful DELETEs.

• You can also validate the response body, headers, etc., if needed.

Suggested Posts:

1. Automate GET API in Playwright
2. Automate POST API in Playwright
3. Automate PUT API in Playwright
4. Automate Lombok API in Playwright
5. Test API by POJO Class in Playwright