Skip to main content

Python - Good API File Design for RESTful API in Flask

🐍 Let us go through a good design to writing APIs.

Resources > entity.py

#inside resources create a python file for the entity
from flask_restful import Resource
from models.store import StoreModel

 class Store(Resource):
    def get(self, name):
        #get from models
        store = storeModel.find_by_name(name)
        #if got
        if store:
            return store.json()
        #else
        return {'message': 'Store not found'}, 404

     def post(self, name):
        #check if already exists by get request with the name
        if storeModel.find_by_name(name):
            return {'message': 'A Store with name {} already there in database. Use another name.'.format(name)}, 400
        #if not there we proceed to put
        #we put the data and convert in an object of the type that would match the structure in database table and also to create a json output to return as success message
        #create object name store using class StoreModel in Models folder
        store = StoreModel(name)
        #try to save using save function created in StoreModel
        try:
            store.save_to_db()
        except:
            #return error if something goes wrong and save function is not completed
            return {'message': 'An error occured while creating the store.'}, 500
        #convert object to json using a function defined in StoreModel class in store.py in Models folder
        return store.json(), 201

     def put(self, name):
        pass

     def delete(Self, name):
        #find store with name in database
        store = StoreModel.find_by_name(name)
        #if found then delete
        if store:
            store.delete_from_db()
        else
        #if not such record, then inform
            return {'message': 'No such record with {}'.format(name)}, 201
        #else give success message
        return {'message': 'Store named {} deleted'.format(name)}, 201

         #get All Stores
class StoreList(Resource):
    def get(self):
        #get all and return in json format
        return {'stores': [store.json() for store in StoreModel.query.all()]}


Comments

Post a Comment

Popular posts from this blog

Python - List - Append, Count, Extend, Index, Insert, Pop, Remove, Reverse, Sort

🐍 Advance List List is widely used and it's functionalities are heavily useful. Append Adds one element at the end of the list. Syntax list1.append(value) Input l1 = [1, 2, 3] l1.append(4) l1 Output [1, 2, 3, 4] append can be used to add any datatype in a list. It can even add list inside list. Caution: Append does not return anything. It just appends the list. Count .count(value) counts the number of occurrences of an element in the list. Syntax list1.count(value) Input l1 = [1, 2, 3, 4, 3] l1.count(3) Output 2 It returns 0 if the value is not found in the list. Extend .count(value) counts the number of occurrences of an element in the list. Syntax list1.extend(list) Input l1 = [1, 2, 3] l1.extend([4, 5]) Output [1, 2, 3, 4, 5] If we use append, entire list will be added to the first list like one element. Extend, i nstead of considering a list as one element, it joins the two lists one after other. Append works in the following way. Input l1 = [1, 2, 3] l1.append([4, 5]) Output...
Post a Comment
Read more

Difference between .exec() and .execPopulate() in Mongoose?

Here I answer what is the difference between .exec() and .execPopulate() in Mongoose? .exec() is used with a query while .execPopulate() is used with a document Syntax for .exec() is as follows: Model.query() . populate ( 'field' ) . exec () // returns promise . then ( function ( document ) { console . log ( document ); }); Syntax for .execPopulate() is as follows: fetchedDocument . populate ( 'field' ) . execPopulate () // returns promise . then ( function ( document ) { console . log ( document ); }); When working with individual document use .execPopulate(), for model query use .exec(). Both returns a promise. One can do without .exec() or .execPopulate() but then has to pass a callback in populate.
1 comment
Read more

Python Class to Calculate Distance and Slope of a Line with Coordinates as Input

🐍  Can be run on Jupyter Notebook #CLASS DESIGNED TO CREATE OBJECTS THAT TAKES COORDINATES AND CALCULATES DISTANCE AND SLOPE class Line:     def __init__(self,coor1,coor2):         self.coor1=coor1         self.coor2=coor2 #FUNCTION CALCULATES DISTANCE     def distance(self):         return ((self.coor2[0]-self.coor1[0])**2+(self.coor2[1]-self.coor1[1])**2)**0.5 #FUNCTION CALCULATES SLOPE         def slope(self):         return (self.coor2[1]-self.coor1[1])/(self.coor2[0]-self.coor1[0]) #DEFINING COORDINATES coordinate1 = (3,2) coordinate2 = (8,10) #CREATING OBJECT OF LINE CLASS li = Line(coordinate1,coordinate2) #CALLING DISTANCE FUNCTION li.distance() #CALLING SLOPE FUNCTION li.slope()
Post a Comment
Read more