Merge pull request #51 from codejunction/main

added pydantic response model as DTO for API

Author: Bachittarjeet

Flask/hello-world-app/app.py

@@ -1,28 +1,37 @@
 # Importing flask module in the project is mandatory
 # An object of Flask class is our WSGI application.
-from flask import Flask
- 
+from flask import Flask, jsonify
+from models import UserInfoRepository
+
 # Flask constructor takes the name of
 # current module (__name__) as argument.
 app = Flask(__name__)
- 
+
 # The route() function of the Flask class is a decorator,
 # which tells the application which URL should call
 # the associated function.
-@app.route('/')
+@app.route("/")
 # ‘/’ URL is bound with hello_world() function.
 def hello_world():
-    return 'Hello World'
+    return "Hello World"
 
-@app.route('/hello/<user_name>')
-def say_hello(user_name:str = None):
+
+@app.route("/hello/<user_name>")
+def say_hello(user_name: str = None):
     if user_name:
-        return f'Hello, {user_name}'
+        return f"Hello, {user_name}"
     else:
         return 'Please provide a name "/hello/\{user_name\}"'
- 
+
+
+@app.route("/api/getUserInfo/<int:limit>")
+def get_all_user_info(limit: int):
+    user_repo: UserInfoRepository = UserInfoRepository()
+    return jsonify(user_repo.get_all_users(limit))
+
+
 # main driver function
-if __name__ == '__main__':
+if __name__ == "__main__":
     # run() method of Flask class runs the application
     # on the local development server.
     app.run(debug=True)

Flask/hello-world-app/models.py

@@ -0,0 +1,40 @@
+from pydantic.main import BaseModel
+from uuid import UUID, uuid4
+from typing import List, Any
+import random as r
+
+
+class ApiReposnseDTO(BaseModel):
+    def __init__(__pydantic_self__, **data: Any) -> None:
+        super().__init__(**data)
+
+    id: UUID = uuid4()
+    userName: str  # provide a username (mandatory field)
+    phoneNumber: int = 0  # provide a phone number (optional field)[default 0]
+    email: str  # provide a emal id (mandatory field)
+
+
+class UserInfoRepository(object):
+    def get_random_phone_number(self) -> int:
+        """Function to generate random phone number
+
+        Returns:
+            int: phone number
+        """
+        phone_number: List[int] = []
+        phone_number.append(r.randint(6, 9))
+        for _ in range(1, 10):
+            phone_number.append(r.randint(0, 9))
+        return int("".join(map(str, phone_number)))
+
+    def get_all_users(self, limit: int = 10) -> List[ApiReposnseDTO]:
+        response: List[ApiReposnseDTO] = []
+        for i in range(limit):
+            response.append(
+                ApiReposnseDTO(
+                    userName=f"userName_{str(i+1)}",
+                    phoneNumber=self.get_random_phone_number(),
+                    email=f"email_{str(i+1)}@gmail.com",
+                ).dict()
+            )
+        return response

Flask/hello-world-app/requirements.txt

@@ -1 +1,2 @@
 flask
+pydantic