Skip to content

Commit c9e0258

Browse files
Update README.md
Added API Testing, CI/CD and Reporting features separately.
1 parent e5bbb91 commit c9e0258

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,30 @@
44
This project is an automation framework for testing APIs using Python and pytest, integrated with CI/CD using GitHub Actions.
55

66
## Features
7-
- Easy-to-use API client
8-
- Automated testing with pytest
9-
- CI/CD setup using GitHub Actions
7+
- API Testing: Validate RESTful APIs using Pytest.
8+
- CI/CD: Intergrate with GitHub Actions for Automated Testing and deployment
9+
- Reporting: Generate detailed HTML reports of test execution.
10+
11+
## API Testing
12+
- Validate RESTful APIs using Pytest.
13+
- Supports GET, POST, PUT, DELETE operations.
14+
- Ensure schema validation, status code checks, response validation.
15+
- Handle authentication (e.g., API tokens) seamlessly in tests.
16+
17+
## CI/CD Integration
18+
- GitHub Actions used for automated testing and deployment.
19+
- Trigger tests on code push or pull requests.
20+
21+
## Reporting
22+
- Generate detailed HTML reports of test execution with pytest-html.
23+
- Include test summaries, passed/failed test details, logs, and timestamps.
24+
- Easily shareable reports to analyze issues and monitor test progress.
25+
- Example report: ```reports/Test_Execution_Report.html.```
1026

1127
## Installation
1228
To install the necessary dependencies, run:
13-
pip install -r requirements.txt
29+
```pip install -r requirements.txt```
1430

1531
Run the test using:
16-
pytest -v -s --html=reports/Test_Execution_Report.html
32+
```pytest -v -s --html=reports/Test_Execution_Report.html```
1733

0 commit comments

Comments
 (0)