This project is a robust API Automation Framework built with Java + REST Assured and designed for scalability, maintainability, and CI/CD readiness. It validates REST APIs against functional requirements, integrates with reporting & logging tools, and follows industry-standard best practices.
The framework is modular, supports test data-driven testing, and integrates seamlessly with CI/CD pipelines (Jenkins) while maintaining clean code quality with SonarLint.
| Category | Tools / Libraries |
|---|---|
| Language | Java (JDK 21 → 24 supported) |
| API Testing | REST Assured |
| Build Tool | Maven |
| Test Framework | TestNG + AssertJ |
| Payload Management | POJOs with GSON & Jackson API |
| Reporting | Allure Report |
| Logging | log4j |
| Test Data | JSON Files & Excel (Apache POI) |
| Linting / Code Quality | SonarLint |
| Version Control | Git & GitHub |
| CI/CD | Jenkins |
API-Automation-Framework/
│── src/main/java/ # Core framework code
│ ├── base/ # Base setup classes
│ ├── utils/ # Utilities (Excel, JSON, Config)
│ ├── pojo/ # Request & Response POJOs
│── src/test/java/ # Test classes
│ ├── tests/ # API test cases
│ ├── data/ # Test data readers
│── testdata/ # JSON & Excel files
│── reports/ # Allure Reports
│── logs/ # log4j logs
│── pom.xml # Maven dependencies
│── README.md # Project documentation
- ✅ Reusable Request Specification for base URI, headers, authentication
- ✅ POJO-based Payload Management using GSON & Jackson API
- ✅ Data-driven Testing via JSON & Excel (Apache POI)
- ✅ Custom Assertions with AssertJ for fluent validation
- ✅ Allure Reporting with detailed test execution insights
- ✅ Centralized Logging using log4j
- ✅ Clean Code Practices enforced by SonarLint
- ✅ Git + Jenkins CI/CD Integration for continuous testing
- Authentication API → Fetch token
- CRUD Operations → Create / Update / Delete resource using REST Assured
- Validation → Assertions using TestNG + AssertJ
- Reporting & Logs → Allure + log4j integration
- Enterprise-grade design – separation of concerns with clean packages
- Scalable test data strategy – JSON + Excel-based approach
- CI/CD Ready – Jenkins & GitHub integration
- Developer Friendly – SonarLint & log4j ensure code quality & traceability
👤 Sharvari Mehta 📩 Email: [email protected] 💼 LinkedIn: linkedin.com/in/sharvarimehta 🚀 GitHub: github.com/sharvarimehta