{"name":"BankAPI-SecureFlow-Automation-Framework","generatedAt":"2026-10-04T08:25:36.506Z","languages":{"Java":20957},"commitTotal":6,"commits":[{"sha":"56268c358d8cb8f030c7c849dda3028c5c2446d4","message":"test file","date":"2025-10-22T08:42:45Z","author":"Aayush Mishra","login":"Aayush-Mishraa","avatar":"https://avatars.githubusercontent.com/u/89012492?v=4","verified":true,"url":"https://github.com/Aayush-Mishraa/BankAPI-SecureFlow-Automation-Framework/commit/56268c358d8cb8f030c7c849dda3028c5c2446d4"},{"sha":"4662f194add5b70c25de09ab31d83ec9c95b689c","message":"Create README.md","date":"2025-10-05T18:01:33Z","author":"Aayush Mishra","login":"Aayush-Mishraa","avatar":"https://avatars.githubusercontent.com/u/89012492?v=4","verified":true,"url":"https://github.com/Aayush-Mishraa/BankAPI-SecureFlow-Automation-Framework/commit/4662f194add5b70c25de09ab31d83ec9c95b689c"},{"sha":"2a7e11d5869cec3f3d5123fa9db448915707c5a3","message":"Correction in xml file","date":"2025-10-05T17:42:33Z","author":"Ayush Mishra","login":"Aayush-Mishraa","avatar":"https://avatars.githubusercontent.com/u/89012492?v=4","verified":false,"url":"https://github.com/Aayush-Mishraa/BankAPI-SecureFlow-Automation-Framework/commit/2a7e11d5869cec3f3d5123fa9db448915707c5a3"},{"sha":"6b813636aae445904cc99bd62760332504f72e58","message":"Fixed TestNG classpath issue: Updated `testng.xml` to correctly\nreference `LoginUserAPITest` and ensured the class is present and\ncompiled under `src/test/java/com/api/tests`.\n\nAlso resolved `NullPointerException` in `AccountCreationTest` by\nreturning the actual `Response` object from `LoggingFilter`.\n\n Cleaned up `log4j2.xml` pattern formatting to eliminate `% -5level`\nerror and added SLF4J binding to suppress `StaticLoggerBinder` warnings.\n\nEverything now compiles and logs as expected. Ready for next round of\ntest coverage!","date":"2025-10-05T17:33:16Z","author":"Ayush Mishra","login":"Aayush-Mishraa","avatar":"https://avatars.githubusercontent.com/u/89012492?v=4","verified":false,"url":"https://github.com/Aayush-Mishraa/BankAPI-SecureFlow-Automation-Framework/commit/6b813636aae445904cc99bd62760332504f72e58"},{"sha":"5e2d3d5323e4adca0dbe7c552f151dd099a69f53","message":"Some correction","date":"2025-10-05T17:21:21Z","author":"Ayush Mishra","login":"Aayush-Mishraa","avatar":"https://avatars.githubusercontent.com/u/89012492?v=4","verified":false,"url":"https://github.com/Aayush-Mishraa/BankAPI-SecureFlow-Automation-Framework/commit/5e2d3d5323e4adca0dbe7c552f151dd099a69f53"},{"sha":"3da3c011470fb297da9556365b9cf1402261ccb5","message":"Base Code","date":"2025-10-05T17:16:38Z","author":"Ayush Mishra","login":"Aayush-Mishraa","avatar":"https://avatars.githubusercontent.com/u/89012492?v=4","verified":false,"url":"https://github.com/Aayush-Mishraa/BankAPI-SecureFlow-Automation-Framework/commit/3da3c011470fb297da9556365b9cf1402261ccb5"}],"readmeHtml":"

🧩 E2E REST API Automation Framework (Rest Assured + Java)

\n

Author: Aayush Mishra

\n

πŸ”— LinkedIn | 🌐 aayushmishra.tech

\n
\n

🎯 Objective

\n

An End-to-End REST API Automation Framework built from scratch using Rest Assured, Java, and TestNG, focused on Banking APIs.
\nThis project demonstrates a complete automation setup β€” from basic API testing to advanced framework design, CI/CD integration, and parallel execution.

\n
\n

🧱 Tech Stack

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
LayerTechnology
LanguageJava 11
FrameworkRest Assured, TestNG
Build ToolMaven
LoggingLog4j2
CI/CDGitHub Actions
ReportingTestNG Reports, Surefire Reports
Design PatternService Object Model (SOM)
\n
\n

βš™οΈ Key Features

\n\n
\n

πŸ“‚ Project Structure

\n
\nsrc\nβ”œβ”€β”€ main/java/com/api\nβ”‚   β”œβ”€β”€ config\nβ”‚   β”œβ”€β”€ models\nβ”‚   β”‚   β”œβ”€β”€ request\nβ”‚   β”‚   └── response\nβ”‚   β”œβ”€β”€ services\nβ”‚   └── utils\n└── test/java/com/api\nβ”œβ”€β”€ filters\nβ”œβ”€β”€ listeners\n└── tests\n\n
\n
\n

πŸ§ͺ Example Test (Login API)

\n
@Test\npublic void testSuccessfulLogin() {\n    LoginRequest request = new LoginRequest(\"testuser\", \"testpass\");\n    Response response = authService.login(request);\n\n    assertEquals(200, response.getStatusCode());\n    LoginResponse loginResponse = response.as(LoginResponse.class);\n    assertNotNull(loginResponse.getToken());\n}
\n

This example validates the login endpoint and ensures that the response token is not null.

\n
\n

🧰 Dependencies (pom.xml)

\n
<dependencies>\n    <!-- Rest Assured -->\n    <dependency>\n        <groupId>io.rest-assured</groupId>\n        <artifactId>rest-assured</artifactId>\n        <version>5.3.0</version>\n    </dependency>\n\n    <!-- TestNG -->\n    <dependency>\n        <groupId>org.testng</groupId>\n        <artifactId>testng</artifactId>\n        <version>7.10.2</version>\n        <scope>test</scope>\n    </dependency>\n\n    <!-- Jackson for JSON serialization -->\n    <dependency>\n        <groupId>com.fasterxml.jackson.core</groupId>\n        <artifactId>jackson-databind</artifactId>\n        <version>2.18.2</version>\n    </dependency>\n\n    <!-- Log4j2 -->\n    <dependency>\n        <groupId>org.apache.logging.log4j</groupId>\n        <artifactId>log4j-core</artifactId>\n        <version>2.20.0</version>\n    </dependency>\n</dependencies>
\n
\n

🧩 Framework Overview

\n

πŸ”Έ Base Configuration

\n

Centralized setup for environment variables, base URLs, and reusable request specifications.

\n

πŸ”Έ Service Layer

\n

Implements core API actions (AuthService, UserService, etc.) built on top of the reusable BaseService.

\n

πŸ”Έ Model Layer

\n

Defines POJOs for request and response payloads β€” enabling cleaner serialization/deserialization.

\n

πŸ”Έ Test Layer

\n

Contains TestNG-based test cases grouped under auth, user, etc., integrated with listeners and filters.

\n

πŸ”Έ Filters & Logging

\n

Custom filters for intercepting requests and responses using Rest Assured Filters and Log4j2.

\n
\n

🧡 Parallel Execution Support

\n

The framework supports multi-threaded execution using ThreadLocal for thread safety.

\n

Run parallel tests using:

\n
mvn clean test -Dsuite=parallel
\n

TestNG example:

\n
<suite name=\"Parallel Suite\" parallel=\"methods\" thread-count=\"4\">\n    <classes>\n        <class name=\"com.api.tests.AuthTest\"/>\n        <class name=\"com.api.tests.UserTest\"/>\n    </classes>\n</suite>
\n
\n

⚑ CI/CD Integration (GitHub Actions)

\n

The workflow automatically runs the API test suite on each push, PR, or scheduled run.

\n
name: API Test Automation\n\non:\n  push:\n    branches: [ main, master ]\n  pull_request:\n    branches: [ main, master ]\n  schedule:\n    - cron: '0 2 * * *'      # Daily at 2 AM UTC\n    - cron: '0 14 * * 1,4'   # Monday & Thursday at 2 PM UTC\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v3\n\n      - name: Set up JDK\n        uses: actions/setup-java@v3\n        with:\n          java-version: '11'\n          distribution: 'temurin'\n          cache: 'maven'\n\n      - name: Run API Tests\n        run: mvn clean test -Dsuite=regression
\n
\n

🧾 Execution Commands

\n
# Run regression suite\nmvn clean test -Dsuite=regression\n\n# Run smoke suite\nmvn clean test -Dsuite=smoke\n\n# Run specific groups\nmvn clean test -Dgroups=auth,user\n\n# Enable parallel execution\nmvn clean test -Dthreads=4
\n
\n

πŸ“Š Reporting & Logs

\n\n
\n

πŸ”„ CI/CD Results

\n

Each pipeline run automatically:

\n\n
\n

🧠 Key Design Patterns Used

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PatternPurpose
Service Object Model (SOM)Encapsulates business logic for APIs
ThreadLocalEnables parallel-safe execution
Builder/FactorySimplifies object creation for requests
ConfigManagerCentralized property management
\n
\n

πŸš€ Future Enhancements

\n\n
\n

🀝 Contributing

\n

Contributions, improvements, and feedback are always welcome.\nFeel free to fork the repository, raise issues, or suggest enhancements.

\n
\n

πŸ“§ Contact

\n

Aayush Mishra\nπŸ“ India\nπŸ“« LinkedIn | 🌐 aayushmishra.tech

\n
\n
\n

β€œQuality is not an act, it’s a habit.”\nβ€” Aristotle

\n
\n
","tree":{"fileCount":28,"dirCount":14,"truncated":false,"extensions":[{"ext":"java","count":17},{"ext":"prefs","count":3},{"ext":"xml","count":3},{"ext":"classpath","count":1},{"ext":"gitignore","count":1},{"ext":"project","count":1},{"ext":"md","count":1},{"ext":"other","count":1}],"topLevel":[{"name":".settings","type":"dir"},{"name":"src","type":"dir"},{"name":".classpath","type":"file"},{"name":".gitignore","type":"file"},{"name":".project","type":"file"},{"name":"pom.xml","type":"file"},{"name":"README.md","type":"file"},{"name":"suite.xml","type":"file"},{"name":"test file","type":"file"}]}}