API Automation with REST Assured

In today’s fast-paced development environments, API testing is a critical part of ensuring application functionality. REST Assured is a powerful Java-based library that simplifies the process of automating REST API tests. It allows developers and testers to write readable, maintainable, and efficient test scripts with minimal setup.

Here’s a step-by-step guide to API automation using REST Assured.


What is REST Assured?

REST Assured is an open-source library for testing RESTful web services. Built on top of Java, it integrates well with testing frameworks like JUnit or TestNG and supports BDD-style syntax for readable test cases.


Add REST Assured to Your Project

For Maven users, add the following dependency in your pom.xml:

<dependency>

  <groupId>io.rest-assured</groupId>

  <artifactId>rest-assured</artifactId>

  <version>5.3.0</version>

  <scope>test</scope>

</dependency>

You may also include dependencies for TestNG or JUnit based on your testing framework.


Write a Simple GET Request Test

import io.restassured.RestAssured;

import static io.restassured.RestAssured.*;

import static org.hamcrest.Matchers.*;

import org.testng.annotations.Test;

public class ApiTest {

    @Test

    public void testGetUsers() {

        RestAssured.baseURI = "https://reqres.in/api";

        given().

            when().

                get("/users?page=2").

            then().

                statusCode(200).

                body("data[0].id", equalTo(7));

    }

}

This test:

  • Sends a GET request
  • Verifies status code is 200
  • Validates response content


POST Request with Payload

@Test

public void testCreateUser() {

    String payload = "{ \"name\": \"John\", \"job\": \"developer\" }";

    given().

        header("Content-Type", "application/json").

        body(payload).

    when().

        post("/users").

    then().

        statusCode(201).

        body("name", equalTo("John")).

        body("job", equalTo("developer"));

}

This test checks whether a new user is successfully created via POST.


Other HTTP Methods

REST Assured supports:

PUT – to update resources

DELETE – to remove resources

PATCH – for partial updates

Each method follows a similar syntax pattern.


Best Practices

  • Use Base URI and path parameters to avoid repetition
  • Use data-driven testing with TestNG or JUnit
  • Add logging (log().all()) for debugging failed tests
  • Integrate with CI/CD pipelines for continuous testing


Conclusion

REST Assured makes API automation easy and effective for Java developers. Its readable syntax and seamless integration with Java testing frameworks make it a top choice for RESTful API testing. With REST Assured in your toolkit, you can confidently validate your APIs and improve overall application quality.

Learn Fullstack Software Testing Tools Training in Hyderabad

Read More:

Using Allure for Test Reporting

Continuous Testing with GitHub Actions

Understanding the Basics of Appium for Mobile Testing

Choosing the Right Automation Tool for Your Project

Visit our IHub Talent Training Institute

Get Direction

Comments

Post a Comment

Popular posts from this blog

Tosca Installation and Environment Setup

 Tosca by Tricentis is a powerful tool for model-based test automation. It supports testing across various technologies like web, mobile, API, and enterprise applications. Setting up Tosca correctly is the first step towards building reliable and scalable test cases. In this blog, we’ll guide you through the Tosca installation process and the essential environment setup required to get started. System Requirements Before installing Tosca, ensure your system meets the following minimum requirements: Operating System: Windows 10 (64-bit) or later RAM: 8 GB (16 GB recommended) Disk Space: At least 10 GB free space .NET Framework: Version 4.7.2 or higher Microsoft SQL Server: Express, Standard, or Enterprise (for shared repositories) Downloading Tosca Visit the Tricentis Support Portal or Tricentis Official Website. Log in or create an account. Navigate to the Downloads section and select Tosca Testsuite. Choose the latest stable version and download the installer (typically in .exe fo...
Read more

Understanding Tosca TestCases and Modules

 Tosca by Tricentis is a powerful model-based test automation tool widely used for functional and regression testing. One of its biggest strengths lies in its no-code approach to test creation, enabling testers to build robust automated tests without needing deep programming skills. At the heart of Tosca’s architecture are Modules and TestCases, two essential components that help in designing, executing, and maintaining automated tests efficiently. In this blog, we’ll explore what Tosca Modules and TestCases are, how they work, and how they contribute to effective test automation. What Are Tosca Modules? Modules in Tosca represent the building blocks of your test automation framework. They are reusable components that store the technical information about the UI elements (like buttons, fields, checkboxes) or APIs under test. Modules are created by scanning the application and capturing its elements. There are two types of modules: Standard Modules: These are created by scanning the...
Read more

How Tosca Handles TestData Parameterization

Tosca by Tricentis is a powerful test automation tool that provides robust support for test data parameterization, enabling reusable and maintainable test cases. Parameterization in Tosca allows testers to replace hardcoded values with dynamic data, making it easier to run the same test with multiple data sets. Here’s how Tosca handles test data parameterization: Using TestCase-Level Parameters You can define TestCase parameters to pass values dynamically into a test case. Steps: Right-click the TestCase and choose "Create TestCase Parameter". Assign a name (e.g., Username) and a default value. In your TestStep, reference the parameter using the syntax ={ParameterName}. Example: ={Username} You can override these parameters when calling the TestCase in another TestCase or in the TestCase folder. Using TestSheet/TestDataService (TDS) Tosca allows parameterization via TestSheets, a part of the Tosca TestCase Design module. This is the most scalable and maintainable way to manag...
Read more