Skip to content

A professional, scalable Java-based framework for automated REST API testing, built with RestAssured, JUnit 5, and Maven.

License

Notifications You must be signed in to change notification settings

kfrural/api-test-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

107 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

API Test Framework

A professional, scalable Java-based framework for automated REST API testing, built with RestAssured, JUnit 5, and Maven.

βœ… Features

  • Full support for HTTP methods: GET, POST, PUT, DELETE
  • Reusable API client and request builder
  • Environment configuration via properties file
  • JSON serialization/deserialization (Jackson)
  • Centralized base test setup
  • Dynamic test data loading (from JSON)
  • Token-based authentication support (extendable)
  • Ready for CI/CD integration
  • Optional Allure report integration

πŸš€ Getting Started

1. Clone the repository

git clone https://github.com/your-org/api-test-framework.git
cd api-test-framework

2. Configure the environment

Edit src/test/resources/config.properties:

base.url=https://your-api-url.com

3. Run tests

mvn clean test

πŸ§ͺ Sample Test Data

Test payloads are stored in JSON format under src/test/resources/testdata/.

Example:

{
  "name": "JoΓ£o Teste",
  "email": "joao@example.com"
}

You can load them dynamically into test cases or parameterized tests.


πŸ“¦ Requirements

  • Java 11+
  • Maven 3+
  • Internet access (to download dependencies)

πŸ“Š Reporting (optional)

This framework supports Allure reporting:

mvn clean test
allure serve target/allure-results

Make sure Allure is installed locally.


πŸ’‘ Future Enhancements

  • Schema validation using JSON Schema Validator
  • OAuth2 authentication flow support
  • Test result notification integration (Slack, Teams)
  • Parallel execution configuration

πŸ›‘ License

This project is licensed under the MIT License - use it freely in your test automation projects.

About

A professional, scalable Java-based framework for automated REST API testing, built with RestAssured, JUnit 5, and Maven.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages