Repository files navigation

1. Project Overview
2. Features
3. Installation
4. Configuration
5. Usage
6. Folder Structure
7. Dependencies
8. Reporting and Logs
9. Contributing
10. License

Therestassured-api-learning-path is a Java-based API testing framework designed to automate REST API validations usingRestAssured,TestNG, andHamcrest. It supports comprehensive CRUD operations across multiple public APIs and includes structured logging, assertions, and POJO-based deserialization withJackson. The framework leveragesDataFaker to generate dynamic and localized test data, enhancing variability in test scenarios.

This framework includes test scenarios against the following public/mock APIs:

• Zippopotam.us API
  Provides postal code and location data for validating JSON structure and values.
  🔗http://api.zippopotam.us

• GoRest API
  User and comment management with full CRUD support.
  🔗https://gorest.co.in/public/v2

• Campus API (Mersys)
  Simulates country/location management with role-based authentication.
  🔗https://test.mersys.io

• Restful-Booker API
  Designed to simulate hotel booking flows with authentication and full lifecycle actions (POST,PUT,PATCH,DELETE).
  🔗https://restful-booker.herokuapp.com

• Reqres API
  Allows testing of pagination, user creation, and BDD validations.
  🔗https://reqres.in/api

For detailed test implementations, seeKey Test Scenarios.

• API Testing with RestAssured
  Supports HTTP methods includingGET,POST,PUT,PATCH, andDELETE for comprehensive API coverage.

• POJO Modeling
  Enables object-oriented validation by deserializing JSON responses into clean, reusable Java POJO classes.

• Behavior-Driven Development (BDD)
  Uses TestNG annotations and fluent RestAssured syntax to define test flows clearly and readably.

• Data Randomization with DataFaker
  Integratesnet.datafaker to generate realistic and localized test data dynamically.

• Reusable Specifications
  UtilizesRequestSpecification andResponseSpecification to centralize request/response configurations.

• Token-Based Authentication
  Handles authentication dynamically using tokens (e.g., for secured booking APIs).

• API Key Authentication
  Supports header-based API key testing (e.g., for role-restricted endpoints like Campus API).

• Comprehensive Logging
  Automatically logs URIs, request/response bodies, headers, and status codes to simplify debugging.

• Dependency Management with Maven
  Ensures reliable builds and version control through Maven with clearly defined dependencies.

• Multi-API Integration
  Implements test flows across five different public APIs to validate CRUD operations, auth flows, and data handling.

1. Clone the Repository:

   git clone https://github.com/cihat-kose/restassured-api-learning-path.git

2. Import the Project in IntelliJ IDEA:

   • Open IntelliJ IDEA.
   • SelectFile > Open and choose the project folder.
   • Ensure Maven auto-import is enabled to download dependencies.

3. Install Plugins (if required):

   • TestNG andRestAssured support plugins in IntelliJ IDEA for enhanced IDE integration.

• TestNG.xml: Defines the suite structure and test class execution flow.
• pom.xml: Manages dependencies and configurations for the framework.

To run tests, use Maven or execute directly from IntelliJ IDEA.

mvn cleantest

• Right-click onTestNG.xml and selectRun to execute all tests.
• Alternatively, right-click any test class or method to run specific tests.

1. _01_APITestIntro.java
   Intro to basicGET requests, response logging, JSON field validation, and assertions with Hamcrest.

2. _02_APITestSpec.java
   Demonstrates usage of reusable specifications withRequestSpecBuilder andResponseSpecBuilder.

3. _03_APITestExtract.java
   Focuses on extracting response data using.path() and validating with TestNG assertions.

4. _04_APITestPOJO.java
   Shows how to deserialize JSON responses into custom POJO classes likeLocation andPlace.

5. _05_Tasks.java
   Collection of exercise-style test cases usingjsonplaceholder.typicode.com with validation and POJO handling.

6. _06_PathAndJSONPath.java
   Explains and contrasts usage of.path() vs.jsonPath() in extracting nested JSON data and converting to Java objects.

7. _07_GoRestUsersTest.java
   Handles user creation, retrieval by ID, updating, and deletion using GoRest API.

8. _08_GoRestCommentTest.java
   Manages comments: creation, retrieval, update, and deletion.

9. _09_CountryTest.java
   Covers country creation, duplicate checks, updates, and deletions in the Campus API.

10. _10_RestfulBookerAPITest.java
    Tests hotel booking flows: token generation, booking creation, update (PUT & PATCH), retrieval, and deletion.

11. _11_ReqresUserTest.java
    Includes status code checks, BDD-style tests, and user creation with POST.

12. _12_APIKeyTest.java
    Demonstrates sending authenticated requests using API keys.

This project commonly encounters a variety of HTTP status codes in responses. Below is a summary of some frequently used status codes and their meanings:

cihat-kose/restassured-api-learning-path/│├── src/│   └── test/│       ├── java/│       │   ├── model/                        # POJO models for JSON response data│       │   │   ├── Country.java│       │   │   ├── Location.java│       │   │   ├── Place.java│       │   │   ├── ToDo.java│       │   │   └── User.java│       │   ├── _01_APITestIntro.java        # Intro to basic API tests and assertions│       │   ├── _02_APITestSpec.java         # Reusable request/response specifications│       │   ├── _03_APITestExtract.java      # Extracting and asserting response data│       │   ├── _04_APITestPOJO.java         # Deserialization into POJOs│       │   ├── _05_Tasks.java               # Task-style practical API test cases│       │   ├── _06_PathAndJSONPath.java     # Path vs JSONPath comparison│       │   ├── _07_GoRestUsersTest.java     # GoRest: user CRUD│       │   ├── _08_GoRestCommentTest.java   # GoRest: comment CRUD│       │   ├── _09_CountryTest.java         # Campus API: country CRUD│       │   ├── _10_RestfulBookerAPITest.java# Restful-Booker: full booking flow│       │   ├── _11_ReqresUserTest.java      # ReqRes: status & BDD testing│       │   └── _12_APIKeyTest.java          # API Key authentication testing│       ││├── TestNG.xml                              # TestNG suite configuration│├── target/                                  # Build output (generated)├── images/                                  # Project images│   └── HTTP_Status_Codes.png                # HTTP status codes reference image├── pom.xml                                  # Maven build configuration└── README.md                                # Project overview and structure

⚠️ This project uses Java 21 features (e.g., text blocks, modern APIs). Ensure your JDK version is 21 or above.

Dependencies are managed inpom.xml. Key dependencies include:

• RestAssured: For making HTTP requests to test APIs.
• TestNG: For organizing and managing test execution.
• Hamcrest: For enhanced assertions in test validations.
• Jackson: For JSON serialization and deserialization.
• DataFaker: For generating realistic and localized fake test data.
• SLF4J (Simple Logging Facade for Java): For logging support.

This framework logs API requests and responses, which can be useful for debugging. Logs include:

• Request and Response Bodies: Automatically logged for all test methods.
• Status Codes and Headers: Available in logs to confirm correct responses.

Test results and logs are saved in thetarget directory after test execution.

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -m 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Open a Pull Request.

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