Skip to content

Commit d6f6469

Browse files
committed
docs: add architectural diagram guidelines to README
1 parent 80f270d commit d6f6469

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,48 @@ A professional, enterprise-grade API testing framework built with Python. This f
1313
### Architecture
1414
![Framework Architecture](images/architecture.png)
1515

16+
17+
18+
graph TB
19+
subgraph "Framework Components"
20+
Tests[Test Suites<br/>tests/]
21+
Utils[Utilities<br/>utils/]
22+
Config[Configuration<br/>config/]
23+
Schemas[JSON Schemas<br/>schemas/]
24+
Data[Test Data<br/>data/]
25+
end
26+
27+
subgraph "External Systems"
28+
API[ReqRes API<br/>reqres.in]
29+
CI[GitHub Actions<br/>CI/CD]
30+
Reports[Allure Reports]
31+
end
32+
33+
Tests --> Utils
34+
Utils --> API
35+
Tests --> Config
36+
Tests --> Schemas
37+
Tests --> Data
38+
API --> Utils
39+
Tests --> Reports
40+
CI --> Tests
41+
42+
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
1658
This diagram shows how different components of the framework interact with each other.
1759

1860
This framework is designed to test the [ReqRes Public API](https://reqres.in/) but can be adapted for any RESTful API. It incorporates:

0 commit comments

Comments
 (0)