Merge pull request #15 from codeasarjun/rest

codeasarjun · web-flow · commit e386bd458f10 · 2024-08-30T08:32:54.000+05:30
REST API has been added
diff --git a/additional-materials/RESTAPI/README.md b/additional-materials/RESTAPI/README.md
@@ -0,0 +1,37 @@
+# What is REST?
+
+REST (Representational State Transfer) is an architectural style for designing networked applications. It relies on stateless, client-server communication and uses standard HTTP methods for interactions. Key principles of REST include:
+
+- **Statelessness:** Each request from a client must contain all the information needed to process the request.
+- **Client-Server Architecture:** Separation of client and server responsibilities.
+- **Uniform Interface:** A consistent and uniform way of interacting with resources.
+- **Cacheability:** Responses must explicitly indicate whether they are cacheable.
+- **Layered System:** The API should be designed with layers, where each layer interacts only with the adjacent layer.
+
+## HTTP Methods Used in REST
+
+REST APIs use standard HTTP methods to perform operations on resources:
+
+- **GET:** Retrieve data from the server.
+- **POST:** Create a new resource on the server.
+- **PUT:** Update an existing resource.
+- **DELETE:** Remove a resource from the server.
+- **PATCH:** Apply partial updates to a resource.
+
+## Resources and Endpoints
+
+- **Resource:** An entity or object that you interact with, such as a user or a product.
+- **Endpoint:** A specific URL where resources are accessed.
+
+## Status Codes
+
+HTTP status codes indicate the result of an API request:
+
+- **200 OK:** The request was successful.
+- **201 Created:** A resource was successfully created.
+- **204 No Content:** The request was successful, but there's no content to return.
+- **400 Bad Request:** The request was invalid.
+- **401 Unauthorized:** Authentication is required or failed.
+- **403 Forbidden:** Access to the resource is denied.
+- **404 Not Found:** The requested resource was not found.
+- **500 Internal Server Error:** An error occurred on the server.
diff --git a/additional-materials/RESTAPI/api_end_points.json b/additional-materials/RESTAPI/api_end_points.json
@@ -0,0 +1,196 @@
+{
+    "openapi": "3.0.0",
+    "info": {
+      "title": "Task Management API",
+      "version": "1.0.0",
+      "description": "A simple API for managing tasks."
+    },
+    "servers": [
+      {
+        "url": "http://127.0.0.1:5000",
+        "description": "Local server"
+      }
+    ],
+    "paths": {
+      "/tasks": {
+        "get": {
+          "summary": "Get all tasks",
+          "responses": {
+            "200": {
+              "description": "A list of tasks",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "tasks": {
+                        "type": "array",
+                        "items": {
+                          "$ref": "#/components/schemas/Task"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "post": {
+          "summary": "Create a new task",
+          "requestBody": {
+            "required": true,
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NewTask"
+                }
+              }
+            }
+          },
+          "responses": {
+            "201": {
+              "description": "The created task",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/Task"
+                  }
+                }
+              }
+            },
+            "400": {
+              "description": "Bad request"
+            }
+          }
+        }
+      },
+      "/tasks/{taskId}": {
+        "get": {
+          "summary": "Get a task by ID",
+          "parameters": [
+            {
+              "name": "taskId",
+              "in": "path",
+              "required": true,
+              "schema": {
+                "type": "integer",
+                "example": 1
+              }
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": "A task",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/Task"
+                  }
+                }
+              }
+            },
+            "404": {
+              "description": "Task not found"
+            }
+          }
+        },
+        "put": {
+          "summary": "Update a task by ID",
+          "parameters": [
+            {
+              "name": "taskId",
+              "in": "path",
+              "required": true,
+              "schema": {
+                "type": "integer",
+                "example": 1
+              }
+            }
+          ],
+          "requestBody": {
+            "required": true,
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Task"
+                }
+              }
+            }
+          },
+          "responses": {
+            "200": {
+              "description": "The updated task",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/Task"
+                  }
+                }
+              }
+            },
+            "404": {
+              "description": "Task not found"
+            },
+            "400": {
+              "description": "Bad request"
+            }
+          }
+        },
+        "delete": {
+          "summary": "Delete a task by ID",
+          "parameters": [
+            {
+              "name": "taskId",
+              "in": "path",
+              "required": true,
+              "schema": {
+                "type": "integer",
+                "example": 1
+              }
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": "Task successfully deleted"
+            },
+            "404": {
+              "description": "Task not found"
+            }
+          }
+        }
+      }
+    },
+    "components": {
+      "schemas": {
+        "Task": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "integer",
+              "example": 1
+            },
+            "title": {
+              "type": "string",
+              "example": "Buy groceries"
+            },
+            "done": {
+              "type": "boolean",
+              "example": false
+            }
+          }
+        },
+        "NewTask": {
+          "type": "object",
+          "required": ["title"],
+          "properties": {
+            "title": {
+              "type": "string",
+              "example": "Read a book"
+            }
+          }
+        }
+      }
+    }
+  }
+  
diff --git a/additional-materials/RESTAPI/app.py b/additional-materials/RESTAPI/app.py
@@ -0,0 +1,56 @@
+from flask import Flask, jsonify, request
+
+app = Flask(__name__)
+
+tasks = [
+    {'id': 1, 'title': 'Buy groceries', 'done': False},
+    {'id': 2, 'title': 'Learn Python', 'done': True}
+]
+
+# get all tasks
+@app.route('/tasks', methods=['GET'])
+def get_tasks():
+    return jsonify({'tasks': tasks})
+
+# get a single task
+@app.route('/tasks/<int:task_id>', methods=['GET'])
+def get_task(task_id):
+    task = next((task for task in tasks if task['id'] == task_id), None)
+    if task is None:
+        return jsonify({'error': 'Task not found'}), 404
+    return jsonify({'task': task})
+
+# create a new task
+@app.route('/tasks', methods=['POST'])
+def create_task():
+    if not request.json or 'title' not in request.json:
+        return jsonify({'error': 'Bad request'}), 400
+    task = {
+        'id': tasks[-1]['id'] + 1,
+        'title': request.json['title'],
+        'done': False
+    }
+    tasks.append(task)
+    return jsonify({'task': task}), 201
+
+# update an existing task
+@app.route('/tasks/<int:task_id>', methods=['PUT'])
+def update_task(task_id):
+    task = next((task for task in tasks if task['id'] == task_id), None)
+    if task is None:
+        return jsonify({'error': 'Task not found'}), 404
+    if not request.json:
+        return jsonify({'error': 'Bad request'}), 400
+    task['title'] = request.json.get('title', task['title'])
+    task['done'] = request.json.get('done', task['done'])
+    return jsonify({'task': task})
+
+# delete a task
+@app.route('/tasks/<int:task_id>', methods=['DELETE'])
+def delete_task(task_id):
+    global tasks
+    tasks = [task for task in tasks if task['id'] != task_id]
+    return jsonify({'result': 'Task deleted'})
+
+if __name__ == '__main__':
+    app.run(debug=True)
diff --git a/additional-materials/RESTAPI/rest_calls.py b/additional-materials/RESTAPI/rest_calls.py
@@ -0,0 +1,17 @@
+import requests
+
+# get all tasks
+response = requests.get('http://127.0.0.1:5000/tasks')
+print(response.json())
+
+# create a new task
+response = requests.post('http://127.0.0.1:5000/tasks', json={'title': 'Read a book'})
+print(response.json())
+
+# update a task
+response = requests.put('http://127.0.0.1:5000/tasks/1', json={'title': 'Buy groceries', 'done': True})
+print(response.json())
+
+# delete a task
+response = requests.delete('http://127.0.0.1:5000/tasks/2')
+print(response.json())
