add: readme.md

Puskar-Roy · Oct 18, 2024 · 9adaef3 · 9adaef3
1 parent affe9d0
commit 9adaef3
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/packages/APIs/Crud_API/.prettierignore b/packages/APIs/Crud_API/.prettierignore
@@ -0,0 +1,6 @@
+# Ignore all Markdown files
+*.md
+
+# You can also ignore specific files or directories if needed
+node_modules/
+dist/
diff --git a/packages/APIs/Crud_API/readme.md b/packages/APIs/Crud_API/readme.md
@@ -0,0 +1,11 @@
+### API Summary 📝
+
+
+Operation | HTTP Method | Endpoint | Description | Example Response
+-- | -- | -- | -- | --
+Create | POST | /resource | Create a new resource | 201 Created
+Read | GET | /resource | Retrieve all resources | 200 OK
+Read | GET | /resource/:id | Retrieve a specific resource | 200 OK
+Update | PUT | /resource/:id | Update a specific resource | 200 OK
+Delete | DELETE | /resource/:id | Delete a specific resource | 200 OK
+