|
8 | 8 |
|
9 | 9 | A professional, enterprise-grade API testing framework built with Python. This framework demonstrates modern testing practices including contract testing, data-driven testing, and comprehensive CI/CD integration. |
10 | 10 |
|
11 | | -## 📋 Overview |
| 11 | +## � Table of Contents |
| 12 | + |
| 13 | +- [📋 Overview](#-overview) |
| 14 | +- [✅ Features](#-features) |
| 15 | +- [🗂️ Project Structure](#️-project-structure) |
| 16 | +- [🔌 API Endpoints](#-api-endpoints) |
| 17 | +- [⚙️ Prerequisites](#️-prerequisites) |
| 18 | +- [🛠️ Installation](#️-installation) |
| 19 | +- [🚀 Quick Start](#-quick-start) |
| 20 | +- [🛠️ Development Setup](#️-development-setup) |
| 21 | +- [🧪 Running Tests](#-running-tests) |
| 22 | +- [📊 Generating Reports](#-generating-reports) |
| 23 | +- [📊 Test Execution & Reports](#-test-execution--reports) |
| 24 | +- [🔍 Test Categories](#-test-categories) |
| 25 | +- [👥 Contributing](#-contributing) |
| 26 | +- [🔐 Security](#-security) |
| 27 | +- [📚 Documentation](#-documentation) |
| 28 | +- [⚠️ Common Issues & Solutions](#️-common-issues--solutions) |
| 29 | +- [🤝 Support](#-support) |
| 30 | +- [📄 License](#-license) |
| 31 | + |
| 32 | +## �📋 Overview |
12 | 33 |
|
13 | 34 | ### Architecture |
14 | 35 |  |
@@ -71,6 +92,34 @@ API-Test-Automation-Framework/ |
71 | 92 |
|
72 | 93 | --- |
73 | 94 |
|
| 95 | +## 🔌 API Endpoints |
| 96 | + |
| 97 | +This framework tests the [ReqRes API](https://reqres.in/), a hosted REST-API ready to respond to your AJAX requests. The following endpoints are covered: |
| 98 | + |
| 99 | +### User Management |
| 100 | +- **GET** `/api/users` - List users with pagination |
| 101 | +- **GET** `/api/users/{id}` - Get single user by ID |
| 102 | +- **POST** `/api/users` - Create new user |
| 103 | +- **PUT** `/api/users/{id}` - Update existing user |
| 104 | +- **PATCH** `/api/users/{id}` - Partially update user |
| 105 | +- **DELETE** `/api/users/{id}` - Delete user |
| 106 | + |
| 107 | +### Authentication & Resources |
| 108 | +- **POST** `/api/login` - User login |
| 109 | +- **POST** `/api/register` - User registration |
| 110 | +- **GET** `/api/unknown` - List resources |
| 111 | +- **GET** `/api/unknown/{id}` - Get single resource |
| 112 | + |
| 113 | +### Test Coverage |
| 114 | +- ✅ **Positive scenarios**: Valid requests with expected responses |
| 115 | +- ✅ **Negative scenarios**: Invalid requests, malformed data, non-existent resources |
| 116 | +- ✅ **Edge cases**: Boundary values, empty payloads, special characters |
| 117 | +- ✅ **Performance**: Response time validation |
| 118 | +- ✅ **Security**: Input validation and error handling |
| 119 | +- ✅ **Contract testing**: JSON schema validation for all responses |
| 120 | + |
| 121 | +--- |
| 122 | + |
74 | 123 | ## ⚙️ Prerequisites |
75 | 124 |
|
76 | 125 | - Python 3.10 or higher |
|
0 commit comments