Modern API Testing Framework with Java + Rest Assured + Cucumber

In modern software development, API testing is critical to ensure backend services work correctly, reliably, and securely. Automated API testing helps teams validate endpoints quickly and integrate testing into CI/CD pipelines.

To demonstrate a practical approach, I built an API Automation Framework using Java and BDD principles.

This repository provides a clean and scalable structure to automate REST APIs efficiently.

🔗 GitHub Repository

📌 Why API Automation?

Manual API testing with tools like Postman is useful for quick checks, but it becomes difficult to maintain when the number of test cases grows. A proper automation framework provides:

✅ Faster regression testing
✅ Reusable test components
✅ CI/CD integration
✅ Detailed reporting
✅ Scalable architecture

Automation frameworks built with Java + REST Assured + BDD are widely used in enterprise QA environments.

🛠 Tech Stack Used

This framework uses modern automation tools commonly used by SDET engineers:

Java
REST Assured
Cucumber BDD
Maven
TestNG / JUnit
JSON Schema Validation
Git & GitHub

📂 Project Structure

`

apiAutoFramework
│
├── src
│ ├── main
│ │ ├── java
│ │ └── resources
│ │
│ └── test
│ └── java
│ └── com.electrolab.api
│ │
│ ├── base
│ │ ├── ScenarioContext.java
│ │ └── TestContext.java
│ │
│ ├── config
│ │ ├── ConfigManager.java
│ │ └── Environment.java
│ │
│ ├── hooks
│ │ └── Hooks.java
│ │
│ ├── managers
│ │ ├── ApiManager.java
│ │ └── TokenManager.java
│ │
│ ├── mock
│ │ ├── MockServer.java
│ │ └── UserMock.java
│ │
│ ├── models
│ │ ├── AuthResponse.java
│ │ └── User.java
│ │
│ ├── runners
│ │ └── TestRunners.java
│ │
│ ├── specbuilder
│ │ └── SpecBuilder.java
│ │
│ ├── stepdefinitions
│ │ └── UserSteps.java
│ │
│ └── utils
│ ├── ApiClient.java
│ ├── JsonUtils.java
│ ├── LoggerUtils.java
│ └── RetryAnalyzer.java
│
└── resources
└── features
└── user.feature

⚙️ Framework Features

✔ BDD testing using Cucumber
✔ API testing using RestAssured
✔ Reusable RequestSpecBuilder
✔ Token-based authentication handling
✔ Environment configuration support
✔ Modular and maintainable architecture
✔ Logging and retry mechanisms
✔ JSON utilities for request/response handling

🧪 Sample BDD Scenario
Feature: User API

Scenario: Get users list
Given User calls GET users API
Then response status should be 200

🧱 Request Specification Builder

Reusable request configuration using SpecBuilder.

public class SpecBuilder {

public static RequestSpecification getRequest() {
    return new RequestSpecBuilder()
            .setBaseUri(ConfigManager.get("qa.url"))
            .addHeader("Content-Type", "application/json")
            .build();
}

}

🔐 Token Manager

Handles authentication tokens dynamically and injects them into API requests.

🔧 Running Tests
Run using Maven

Run from IDE
Run the TestRunners.java file.

📊 Future Enhancements

Parallel execution

Allure reports
CI/CD integration (Jenkins / GitHub Actions)
Dockerized test execution
API contract testing
Performance testing integration`