RestAssured API Automation Framework

A robust and scalable API Automation Framework developed in Java using Rest Assured, TestNG, Extent Reports, and the Builder Design Pattern.

This framework is designed to simplify REST API testing with a modular, maintainable, and reusable structure — ideal for individual testers or teams working on API automation projects.

✨ Key Features

✅ Built with Java 17, Rest Assured, TestNG

✅ Implements Builder Design Pattern for cleaner request/response specification management

✅ Integrated Extent Reports for detailed HTML test reporting

✅ Supports soft assertions (with TestNG’s SoftAssert)

✅ Centralized configuration management via properties files

✅ Organized test data and test suites under /resources

✅ Generates detailed reports under /reports

✅ Easily extendable for new APIs and test cases

📁 Project Structure

│ ├── main
│ │ └── java
│ │ └── [framework source code]
│ └── test
│ └── java
│ └── [test cases]
├── resources
│ ├── testdata
│ ├── testsuites
│ └── extent-config.xml
├── reports
│ └── [generated HTML reports]
├── config
│ └── config.properties
├── target
│ └── [build artifacts]
├── README.md
└── pom.xml

Explanation:

✅ /resources → External test data, config, suites

✅ /reports → Auto-generated ExtentReports

✅ /config → Properties/config files

✅ /src/main/java → Framework code (utils, builders, base classes)

✅ /src/test/java → Test classes

🚀 Getting Started

1️⃣ Prerequisites Ensure the following are installed on your system:

Java 17+

Maven

IntelliJ IDEA (or any Java IDE)

Git

Verify installations:

java -version
mvn -version

2️⃣ Clone the Repository Clone the repository to your local machine:

git clone https://github.com/RajatSharan/Restassured-api-automation-framework.git
cd restassured-api-automation-framework

3️⃣ Install Dependencies

The project uses Maven for dependency management. Run the following command to install dependencies:

mvn clean install

✅ Maven will download all required dependencies.

4️⃣ Configure Properties Update the /config/config.properties file as needed:

baseURI=https://api.example.com
reportPath=./reports/

5️⃣ Run Tests To run all tests via Maven:

mvn test
Or, you can run specific test suites via IntelliJ or the terminal.

✅ TestNG will generate results. ✅ Extent Reports will be generated under /reports.

📝 Usage Example A sample test class is located in /src/test/java/getMethod/SoftandHardAssertions.java:

@Test
public void validateSoftAssertionsUtill() {
    SoftAssertionUtill.assertEquals(actualResponse, expectedResponse, "Validating API response");
}
You can add more test classes under /src/test/java following similar patterns.

📊 Reports After test execution:

Navigate to /reports/.

Open the latest .html file in a browser to view the interactive test reports.

Reports are generated using Extent Reports with custom configurations from /resources/extent-config.xml.

🧩 Extending the Framework

✅ Add new API request specifications → Create new Builder classes in /src/main/java.

✅ Add new tests → Create new test classes in /src/test/java.

✅ Add test data → Update /resources/testdata/ or properties files.

✅ Configure reports → Modify /resources/extent-config.xml.