Rest Assured Framework

API Automation Suite with UI

A comprehensive, production-ready API test automation framework with Java Swing UI. Leverage Rest Assured for powerful API testing, Excel-driven data management, and an intuitive graphical interface for test execution and validation.

Project Overview

REST API Testing

Built on Rest Assured library, enabling powerful, intuitive API testing with built-in assertions, request/response validation, and extensive HTTP method support.

Java Swing UI

Intuitive graphical interface for test execution, configuration management, and result visualization making API testing accessible to non-technical users.

Data-Driven Testing

Excel-based test data management enabling parameterized API testing with multiple endpoints, headers, payloads, and expected responses from centralized configuration files.

Technology Stack

Java

Core language for robust API automation

Rest Assured

Powerful library for REST API testing

Java Swing

Desktop UI for test execution

Maven

Build automation and dependencies

Apache POI

Excel data configuration management

Framework Architecture

Design Architecture & Patterns

  • Layered Architecture: Clear separation between API layer, business logic, UI, and utilities
  • Data-Driven Model: Excel configuration for endpoints, parameters, and validation rules
  • Modular Utilities: Reusable components for API calls, response validation, and data handling
  • Configuration Management: Centralized properties for environments, credentials, and API endpoints
  • Swing UI Layer: Desktop application interface for test execution and visualization
  • Report Generation: Automated test result documentation and logging
UI Layer

Java Swing Interface

Test Execution Layer

Test Runners & Validators

API Layer

Rest Assured Wrappers

Utility Layer

Configuration & Data Handlers

API Endpoints

External REST Services

Key Features

HTTP Method Support

Full support for GET, POST, PUT, DELETE, PATCH, and other HTTP methods with request/response validation

Request/Response Validation

Comprehensive assertion framework for status codes, headers, body content, and response time validations

Authentication Support

Built-in support for Basic Auth, OAuth, Bearer tokens, and custom header authentication

Error Handling

Comprehensive error scenarios and edge case handling with detailed logging and reporting

Test Reporting

Detailed test execution reports with pass/fail status, response times, and error details

Environment Configuration

Multi-environment support for development, staging, and production API endpoints

UI Showcase

The Rest Assured Framework includes a Java Swing desktop application that provides an intuitive interface for executing API tests, configuring endpoints, and viewing real-time results without writing code.

Store Menu API

Retrieve and validate menu information for a given store. This API allows testers to fetch menu details through the UI without manual request construction.

  • Query store menu by ID
  • Validate menu structure and content
  • Response time monitoring
  • Export results to Excel
Store Menu API UI

Menu Validation API

Comprehensive validation of menu data against predefined rules. Ensures menu items, pricing, and availability are correct before store operations.

  • Validate menu completeness
  • Check pricing accuracy
  • Verify item availability status
  • Generate validation reports
Menu Validation API UI

Test Order Push API

Push test orders into the store system. Validates order creation, processing, and database updates through API endpoints with real-time feedback.

  • Create test orders with multiple items
  • Validate order acceptance
  • Monitor order status updates
  • Batch test order execution
Test Order Push API UI

Project Structure

API Endpoints
  • Menu Get APIs
  • Menu Validation APIs
  • Order Push APIs
  • Custom Endpoints
UI Components
  • Main Dashboard
  • API Configuration Panel
  • Test Execution View
  • Results Panel
Test Utilities
  • API Request Builder
  • Response Validator
  • ExcelReader/Writer
  • ConfigReader
Data Management
  • config.properties
  • testdata.xlsx
  • API Endpoints Config
  • Validation Rules
Test Runners
  • Main Application
  • API Test Runner
  • Batch Executor
  • Report Generator
Documentation
  • Integration Guide
  • API Reference
  • Configuration Guide
  • Usage Examples