🚀 REST API Automation TestNG Framework

🎯 Robust & Scalable REST API Testing Framework

Enterprise-grade automation framework with data-driven testing, comprehensive reporting, and intelligent logging

Features • Quick Start • Architecture • Documentation

📖 Overview

A production-ready REST API automation testing framework built with industry best practices. This framework leverages the power of Java, TestNG, and Rest Assured to deliver robust, maintainable, and scalable API test automation with Excel-based data-driven testing and rich HTML reporting.

Perfect for QA Engineers, Test Automation Engineers, and Development Teams looking to implement comprehensive API testing strategies.

✨ Features

🔁 Data-Driven Testing Excel-based test data management Apache POI integration Dynamic data providers Easy test data maintenance	📊 Rich Reporting ExtentReports HTML dashboards Detailed test execution logs Screenshot attachments Pass/Fail statistics	🔧 Configuration Management Properties-based endpoints Environment-specific configs Centralized settings Easy deployment
🎯 TestNG Integration Parallel test execution Test suite management Flexible assertions Dependency handling	📝 Intelligent Logging Log4j2 implementation Multiple log levels Rotating file appenders Debug-friendly output	🏗️ Modular Architecture Page Object Model (POM) Reusable components SOLID principles Easy scalability

🔧 Tech Stack & Tools

Technology	Purpose	Version
☕ Java	Programming Language	21
📦 Maven	Build & Dependency Management	Latest
🧪 TestNG	Test Runner & Assertions	Latest
🌐 Rest Assured	REST API Testing	Latest
📊 Apache POI	Excel Data Management	Latest
📈 ExtentReports	HTML Test Reporting	Latest
📝 Log4j2	Logging Framework	Latest
🔀 Git	Version Control	Latest

📁 Project Structure

PetStoreAutomation/
│
├── 📂 src/
│   └── 📂 test/
│       ├── 📂 java/
│       │   └── 📂 api/
│       │       ├── 📂 endpoints/        # REST endpoints & routes
│       │       │   ├── UserEndpoints.java
│       │       │   ├── StoreEndpoints.java
│       │       │   └── PetEndpoints.java
│       │       │
│       │       ├── 📂 payload/          # POJOs for request/response
│       │       │   ├── User.java
│       │       │   ├── Pet.java
│       │       │   └── Order.java
│       │       │
│       │       ├── 📂 test/             # TestNG test classes
│       │       │   ├── UserTests.java
│       │       │   ├── PetTests.java
│       │       │   └── DDTests.java
│       │       │
│       │       └── 📂 utilities/        # Helper classes
│       │           ├── DataProviders.java
│       │           ├── ExcelUtility.java
│       │           ├── ExtentReportManager.java
│       │           └── Endpoints.java
│       │
│       └── 📂 resources/
│           ├── log4j2.xml              # Logging configuration
│           └── routes.properties       # API endpoint URLs
│
├── 📂 testData/                        # Excel test data files
│   └── UserData.xlsx
│
├── 📂 reports/                         # Generated ExtentReports
│   └── Test-Report-{timestamp}.html
│
├── 📂 logs/                            # Application logs
│   └── automation.log
│
├── 📄 testng.xml                       # TestNG suite configuration
├── 📄 pom.xml                          # Maven dependencies & build
├── 📄 .gitignore                       # Git ignore rules
└── 📄 README.md                        # Project documentation

🎯 Framework Architecture

graph TB
    A[TestNG Test Classes] --> B[Data Provider]
    B --> C[Excel Utility]
    C --> D[Test Data Excel]
    A --> E[Endpoints Layer]
    E --> F[Routes Properties]
    E --> G[Rest Assured]
    G --> H[API Server]
    A --> I[ExtentReports]
    A --> J[Log4j2]
    
    style A fill:#4ade80
    style H fill:#3b82f6
    style I fill:#f59e0b
    style J fill:#a855f7

🚀 Getting Started

📋 Prerequisites

Before you begin, ensure you have the following installed:

Requirement	Version	Installation
☕ Java JDK	21+	Download
📦 Maven	3.8+	Download
💻 IDE	Any	IntelliJ IDEA / Eclipse / VS Code
🔀 Git	Latest	Download

⚡ Installation

Step 1️⃣: Clone the Repository

git clone https://github.com/mvsaran/RestAPI-Automation-TestNG-Framework.git
cd RestAPI-Automation-TestNG-Framework

Step 2️⃣: Install Dependencies

mvn clean install

Step 3️⃣: Verify Setup

mvn test -Dtest=UserTests

🧪 Running Tests

▶️ Run All Tests

mvn clean test

🎯 Run Specific Test Suite

mvn test -DsuiteXmlFile=testng.xml

🔍 Run Specific Test Class

mvn test -Dtest=UserTests

🔀 Run Tests in Parallel

mvn test -Dparallel=methods -DthreadCount=4

📊 Run with Custom Report Name

mvn test -DreportName="API-Test-Report"

📊 Test Reports

📈 ExtentReports

After test execution, detailed HTML reports are generated in the reports/ directory.

Features:

✅ Pass/Fail/Skip statistics
📸 Request/Response details
⏱️ Execution time tracking
🎨 Beautiful dashboard view
📋 Test case details with logs

Viewing Reports:

# Navigate to reports directory
cd reports/

# Open the latest report
open Test-Report-{timestamp}.html  # macOS
start Test-Report-{timestamp}.html # Windows
xdg-open Test-Report-{timestamp}.html # Linux

📝 Log Files

Detailed execution logs are available in logs/automation.log

Log Levels:

🔴 ERROR - Critical issues
🟠 WARN - Warning messages
🔵 INFO - General information
🟢 DEBUG - Detailed debugging info

📦 Maven Dependencies

Click to expand pom.xml dependencies

<dependencies>
    <!-- Rest Assured -->
    <dependency>
        <groupId>io.rest-assured</groupId>
        <artifactId>rest-assured</artifactId>
        <version>5.3.0</version>
    </dependency>
    
    <!-- TestNG -->
    <dependency>
        <groupId>org.testng</groupId>
        <artifactId>testng</artifactId>
        <version>7.8.0</version>
    </dependency>
    
    <!-- Apache POI for Excel -->
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.2.3</version>
    </dependency>
    
    <!-- ExtentReports -->
    <dependency>
        <groupId>com.aventstack</groupId>
        <artifactId>extentreports</artifactId>
        <version>5.0.9</version>
    </dependency>
    
    <!-- Log4j2 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.20.0</version>
    </dependency>
    
    <!-- JSON Processing -->
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.10.1</version>
    </dependency>
</dependencies>

🔐 Configuration

📄 routes.properties

Configure your API endpoints in src/test/resources/routes.properties:

# Base URL
base_url=https://petstore.swagger.io/v2

# User Module Endpoints
post_url=/user
get_url=/user/{username}
update_url=/user/{username}
delete_url=/user/{username}

# Store Module Endpoints
store_post_url=/store/order
store_get_url=/store/order/{orderId}

# Pet Module Endpoints
pet_post_url=/pet
pet_get_url=/pet/{petId}
pet_update_url=/pet/{petId}

🔧 log4j2.xml

Customize logging behavior in src/test/resources/log4j2.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <File name="File" fileName="logs/automation.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
    </Loggers>
</Configuration>

📚 Framework Components

🎯 Endpoints Layer

Handles all API endpoint logic with Rest Assured:

public class UserEndpoints {
    
    public static Response createUser(User payload) {
        return given()
            .contentType(ContentType.JSON)
            .accept(ContentType.JSON)
            .body(payload)
        .when()
            .post(Routes.post_url);
    }
    
    public static Response getUser(String userName) {
        return given()
            .pathParam("username", userName)
        .when()
            .get(Routes.get_url);
    }
}

📦 Payload Classes (POJOs)

Define request/response structures:

public class User {
    private int id;
    private String username;
    private String firstName;
    private String lastName;
    private String email;
    private String password;
    private String phone;
    
    // Getters and Setters
}

📊 Data Providers

Excel-based data-driven testing:

@DataProvider(name = "UserData")
public Object[][] getAllData() throws IOException {
    String path = System.getProperty("user.dir") + "//testData//UserData.xlsx";
    XLUtility xl = new XLUtility(path);
    
    int rownum = xl.getRowCount("Sheet1");
    int colcount = xl.getCellCount("Sheet1", 1);
    
    Object[][] apidata = new Object[rownum][colcount];
    
    for (int i = 1; i <= rownum; i++) {
        for (int j = 0; j < colcount; j++) {
            apidata[i-1][j] = xl.getCellData("Sheet1", i, j);
        }
    }
    return apidata;
}

🧪 Test Classes

TestNG test implementation:

public class UserTests {
    
    @Test(priority = 1, dataProvider = "UserData", dataProviderClass = DataProviders.class)
    public void testPostUser(String userID, String userName, String fname, String lname, 
                             String email, String pwd, String ph) {
        
        User userPayload = new User();
        userPayload.setId(Integer.parseInt(userID));
        userPayload.setUsername(userName);
        userPayload.setFirstName(fname);
        userPayload.setLastName(lname);
        userPayload.setEmail(email);
        userPayload.setPassword(pwd);
        userPayload.setPhone(ph);
        
        Response response = UserEndpoints.createUser(userPayload);
        Assert.assertEquals(response.getStatusCode(), 200);
        
        logger.info("User created successfully");
    }
}

🎨 Best Practices Implemented

Practice	Implementation
🏗️ Separation of Concerns	Endpoints, Payloads, Tests, Utilities separated
📦 DRY Principle	Reusable methods and utilities
🔒 Encapsulation	Private fields with getters/setters
📋 Documentation	Comprehensive inline comments
🧪 Test Independence	Each test can run standalone
🔄 Maintainability	Properties-based configuration
📊 Reporting	Detailed logs and HTML reports
🎯 Assertions	Proper validation at each step

🐛 Troubleshooting

Common Issues & Solutions

Issue: Maven build fails

Solution:

mvn clean install -U

Issue: Tests not executing

Solution:

Verify testng.xml configuration
Check if test classes are in correct package
Ensure @Test annotations are present

Issue: Excel file not found

Solution:

Verify file path in DataProviders class
Ensure Excel file is in testData/ directory
Check file name spelling

Issue: Reports not generating

Solution:

Check ExtentReports configuration
Verify reports/ directory exists
Ensure proper file permissions

📈 Continuous Integration

🔄 GitHub Actions

Sample workflow configuration

name: API Test Automation

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]
  schedule:
    - cron: '0 2 * * *'  # Daily at 2 AM

jobs:
  test:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v3
    
    - name: Set up JDK 21
      uses: actions/setup-java@v3
      with:
        java-version: '21'
        distribution: 'temurin'
    
    - name: Build with Maven
      run: mvn clean install -DskipTests
    
    - name: Run Tests
      run: mvn test
    
    - name: Upload Test Reports
      uses: actions/upload-artifact@v3
      if: always()
      with:
        name: test-reports
        path: reports/

🤝 Contributing

Contributions are always welcome! Here's how you can help:

🍴 Fork the repository
🌿 Create your feature branch (git checkout -b feature/AmazingFeature)
✨ Commit your changes (git commit -m 'Add some AmazingFeature')
📤 Push to the branch (git push origin feature/AmazingFeature)
🎉 Open a Pull Request

📝 Contribution Guidelines

Write clear commit messages
Follow existing code style
Add tests for new features
Update documentation as needed
Ensure all tests pass before submitting PR

📞 Support & Contact

Channel	Link
🐛 Report Bug	Create Issue
💡 Request Feature	Create Issue
📧 Email	your.email@example.com
💼 LinkedIn	Your Profile

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2025 REST API Automation Framework

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction...

🙏 Acknowledgments

🌐 Rest Assured - For making API testing simple and elegant
🧪 TestNG - For powerful test management capabilities
📊 Apache POI - For seamless Excel integration
📈 ExtentReports - For beautiful test reports
📝 Log4j2 - For robust logging framework
👥 Open Source Community - For continuous inspiration

📊 Project Statistics

🗺️ Roadmap

🔄 Add support for GraphQL APIs
🔐 Implement OAuth 2.0 authentication
🐳 Docker containerization
☁️ Cloud deployment support (AWS/Azure)
📱 Add API performance testing
🤖 AI-powered test generation
📊 Advanced analytics dashboard
🔗 Swagger integration

⭐ If you find this project helpful, please give it a star!

Made with ❤️ by Test Automation Engineers

⬆ Back to Top

Happy Testing! 🚀

Name		Name	Last commit message	Last commit date
.settings		.settings
logs		logs
reports		reports
src/test		src/test
target		target
test-output		test-output
testData		testData
.classpath		.classpath
.project		.project
README.md		README.md
pom.xml		pom.xml
testng.xml		testng.xml

Latest commit

History

Folders and files

Repository files navigation

🚀 REST API Automation TestNG Framework

🎯 Robust & Scalable REST API Testing Framework

📖 Overview

✨ Features

🔁 Data-Driven Testing

📊 Rich Reporting

🔧 Configuration Management

🎯 TestNG Integration

📝 Intelligent Logging

🏗️ Modular Architecture

🔧 Tech Stack & Tools

📁 Project Structure

🎯 Framework Architecture

🚀 Getting Started

📋 Prerequisites

⚡ Installation

🧪 Running Tests

▶️ Run All Tests

🎯 Run Specific Test Suite

🔍 Run Specific Test Class

🔀 Run Tests in Parallel

📊 Run with Custom Report Name

📊 Test Reports

📈 ExtentReports

📝 Log Files

📦 Maven Dependencies

🔐 Configuration

📄 routes.properties

🔧 log4j2.xml

📚 Framework Components

🎯 Endpoints Layer

📦 Payload Classes (POJOs)

📊 Data Providers

🧪 Test Classes

🎨 Best Practices Implemented

🐛 Troubleshooting

Issue: Maven build fails

Issue: Tests not executing

Issue: Excel file not found

Issue: Reports not generating

📈 Continuous Integration

🔄 GitHub Actions

🤝 Contributing

📝 Contribution Guidelines

📞 Support & Contact

📄 License

🙏 Acknowledgments

📊 Project Statistics

🗺️ Roadmap

⭐ If you find this project helpful, please give it a star!

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages