Skip to content

Commit 53992dc

Browse files
major documentation changes
1 parent b981b91 commit 53992dc

30 files changed

+63
-7
lines changed

Images/Authorization.jpg

137 KB
Loading

Images/MongoDB_Compass.jpg

66.2 KB
Loading

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,28 @@
1414
3. MongoDB Compass
1515
4. MongoDB
1616

17+
<br/>
18+
1719
### All the assignment files are present in Todo-API folder.
1820

21+
<br/>
22+
23+
### Todo.csv and User.csv are exported collections from local MongoDB TodoApp Database.
24+
25+
<br/>
26+
27+
I developed this Todo List API with basic todo app architecture, Many functionalities can me implemented in future like reminders and alerts.
28+
29+
Hope you understand. Check my previous works in the Github link below to have trust in me.
30+
31+
GitHub Link: https://github.com/SaiJeevanPuchakayala?tab=repositories
32+
33+
Kindly go through all the files in the repo.
34+
35+
Trust is Built with Consistency, Thank You!
36+
37+
<br/>
38+
1939
### Feel free to contact me if you have any doubt about this Todo APIs:
2040
* Name: Sai Jeevan Puchakayala
2141
* Phone Number: +91 7288961100

Todo-API/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# TodoApi: Fastapi | MongoDB | REST API
22

3+
</br>
4+
35
## To Run in Local
46

57
1. Clone the project
@@ -19,3 +21,22 @@
1921
http://127.0.0.1:8000/docs
2022
```
2123

24+
</br>
25+
26+
## MongoDB_Compass
27+
![MongoDB_Compass](../Images/MongoDB_Compass.jpg)
28+
29+
## API Authorization
30+
![API Authorization](../Images/Authorization.jpg)
31+
32+
</br>
33+
34+
35+
## Important Notes:
36+
1. Schemas are just to built to understand the params and responses of the API clearly.
37+
2. Most of the code files are built to create API docs in layman's terms.
38+
39+
## References Used
40+
```
41+
https://intility.github.io/fastapi-azure-auth/multi-tenant/fastapi_configuration/
42+
```
-10 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

Todo-API/api/api_v1/router.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
router = APIRouter()
77

8+
# All the routes of API version 1 are combined here.
89
router.include_router(user.user_router, prefix="/users", tags=["users"])
910
router.include_router(todo.todo_router, prefix="/todo", tags=["todo"])
1011
router.include_router(auth_router, prefix="/auth", tags=["auth"])
22 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)