An open API service indexing awesome lists of open source software.

https://github.com/shivshanker869/dummy-employee-api-testing

This repository contains REST API testing for a Dummy Employee Management API using Postman and Newman. It includes CRUD operations like Create, Read, Update, and Delete employee data. Detailed HTML reports are generated using the Newman HTML Extra Reporter. This project demonstrates API automation testing best practices for beginners.
https://github.com/shivshanker869/dummy-employee-api-testing

apitesting automated-testing newman postman rest-api

Last synced: 14 days ago
JSON representation

This repository contains REST API testing for a Dummy Employee Management API using Postman and Newman. It includes CRUD operations like Create, Read, Update, and Delete employee data. Detailed HTML reports are generated using the Newman HTML Extra Reporter. This project demonstrates API automation testing best practices for beginners.

Awesome Lists containing this project

README

          

# ๐Ÿงฉ Dummy Employee API Testing

![Postman](https://img.shields.io/badge/Tool-Postman-orange?logo=postman)
![API](https://img.shields.io/badge/API-Testing-blue)
![REST](https://img.shields.io/badge/Type-REST%20API-success)
![Status](https://img.shields.io/badge/Status-Completed-brightgreen)
![Platform](https://img.shields.io/badge/Platform-dummy.restapiexample.com-lightgrey)

---

## ๐Ÿš€ Project Overview
**Dummy Employee API Testing** is a **Postman-based API testing project** for the public REST API โ€“ [**dummy.restapiexample.com**](https://dummy.restapiexample.com/).
This project validates key RESTful endpoints using **Postman Collections** and **Environments**, covering **CRUD operations (Create, Read, Update, Delete)** for employee data.
It ensures that the API functions as expected and handles valid as well as invalid requests gracefully.

---

## ๐Ÿงฑ Tools & Technologies Used
| Category | Tool / Technology |
|-----------|------------------|
| API Testing Tool | Postman |
| API Type | REST API |
| Environment Setup | Postman Environment Variables |
| Documentation | Postman Collection & JSON Export |
| Data Format | JSON |
| Domain | Employee Management API |

---

## ๐ŸŽฏ Testing Objectives
- โœ… Validate all CRUD endpoints (GET, POST, PUT, DELETE).
- โœ… Ensure correct response codes (200, 201, 400, 404, etc.).
- โœ… Verify response structure, keys, and data consistency.
- โœ… Use Postman Environment for parameterized testing.
- โœ… Automate and chain API requests using Postman variables.

---

## ๐Ÿ“ Project Structure
```
Dummy-Employee-API-Testing/
โ”‚
โ”œโ”€โ”€ Postman_Collection/
โ”‚ โ””โ”€โ”€ DummyEmployeeAPI_Collection.json
โ”‚
โ”œโ”€โ”€ Postman_Environment/
โ”‚ โ””โ”€โ”€ DummyEmployeeAPI_Environment.json
โ”‚
โ”œโ”€โ”€ Screenshots/
โ”‚ โ”œโ”€โ”€ GetAllEmployees.png
โ”‚ โ”œโ”€โ”€ CreateEmployee.png
โ”‚ โ”œโ”€โ”€ UpdateEmployee.png
โ”‚ โ””โ”€โ”€ DeleteEmployee.png
โ”‚
โ””โ”€โ”€ README.md
```

---

## ๐Ÿ” Tested Endpoints

| HTTP Method | Endpoint | Description | Status Code |
|--------------|-----------|--------------|--------------|
| **GET** | `/api/v1/employees` | Retrieve all employee records | 200 |
| **GET** | `/api/v1/employee/{id}` | Retrieve a single employee by ID | 200 / 404 |
| **POST** | `/api/v1/create` | Create a new employee record | 201 |
| **PUT** | `/api/v1/update/{id}` | Update an existing employee record | 200 |
| **DELETE** | `/api/v1/delete/{id}` | Delete an employee record | 200 |

---

## โš™๏ธ How to Run the Project

### ๐Ÿงฉ Step 1: Import Collection & Environment
1. Open **Postman**.
2. Click on **Import โ†’ Upload Files**.
3. Import both:
- `DummyEmployeeAPI_Collection.json`
- `DummyEmployeeAPI_Environment.json`

### ๐Ÿงฉ Step 2: Select Environment
1. Click on the **Environment dropdown** (top-right in Postman).
2. Select **DummyEmployeeAPI Environment**.

### ๐Ÿงฉ Step 3: Execute the Requests
1. Expand the collection โ†’ Click on any API (GET, POST, PUT, DELETE).
2. Click **Send** to execute the request.
3. Observe the **response body, status code**, and **response time**.

---

## ๐Ÿงช Sample Test Cases

| Test Case | Method | Expected Result |
|------------|---------|----------------|
| Fetch all employees | GET | Returns list of employees with status 200 |
| Fetch employee by valid ID | GET | Returns employee data with status 200 |
| Fetch employee by invalid ID | GET | Returns error message with status 404 |
| Create new employee | POST | Returns created employee object with status 201 |
| Update existing employee | PUT | Returns updated details with status 200 |
| Delete employee | DELETE | Returns success message with status 200 |

---

## ๐Ÿ“Š API Response Validation
Each API response was validated for:
- ๐Ÿ”น **HTTP Status Code**
- ๐Ÿ”น **Response Time**
- ๐Ÿ”น **Response Body Keys & Values**
- ๐Ÿ”น **Error Handling & Messages**

---

## ๐Ÿง  Key Learnings
- Understanding of **RESTful API architecture**.
- Hands-on experience with **Postman Environments and Collections**.
- Validation of **CRUD API workflows** and chained requests.
- Practice with **response assertions** and **dynamic variables**.

---

## ๐Ÿ Conclusion
This **Dummy Employee API Testing** project demonstrates structured API testing using Postman.
It ensures that the API endpoints are stable, consistent, and meet expected behavior under various scenarios.
The project reflects a **real-world approach** to REST API validation and documentation.

---

## ๐Ÿ‘ค Author
**Shiv Shanker Gupta**
๐Ÿ’ผ *QA Engineer | Manual & Automation Tester*
๐Ÿ“ง *gopalgupta9639@gmail.com*
๐ŸŒ [GitHub Profile](https://github.com/Shivshanker869)

---

## โญ Show Your Support
If you found this project helpful, please give it a **โญ Star** and share it with others in the QA community!

---