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

Popular posts from this blog

Python - Mathematical Functions - Hexadecimal, Binary, Exponential, Absolute, Round

🐍 Some mathematical functions are in-built in python. Here are some of them. Convert Decimal to Hexadecimal hex(246) Output: '0xf6' hex(512) Output: '0x200' 0x is prefix to all hexadecimal numbers in output. The number after 0x is the hexadecimal value. Convert Decimal to Binary bin(1234) Output: '0b10011010010' bin(246) Output: '0b11110110' bin(512) Output: '0b1000000000' Exponential Function pow() function is similar to num1**num2, but it comes useful when you want to execute (num1**num2)%num3. Passing three arguments to pow(), does this. pow(3,4) Output: 81 This works just like 3**4 pow(3,4,5) Output: 1 But this, works equivalent to (3**4)%5. Either of the two ways can be used. At this point I feel (3**4)%5 is better, as anybody reading the code will understand what is being done immediately. While with pow(2,3,4), the person may have to refer to documentation to understand how this function works. Absolute Value The function abs() is used ...

Two Ways of rendering in React Examples

Two Ways of rendering in React Examples 1 - Render twice HTML < div id = "p1" ></ div > < div id = "p2" ></ div > CSS . person { display : inline - block ; margin : 10px ; border : 1px solid # eee ; box - shadow : 0 2px 2px # ccc ; } JAVASCRIPT (Babel) function Person ( props ) { return ( < div className = ' person "> < h1 >{ props . name }</ h1 > < p > Age :{ props . age }</ p > </ div > ); } ReactDOM . render (< Person name = "VK" age = "29" />, document . querySselector ( '#p1' )); ReactDOM . render (< Person name = "HK" age = "28" />, document . querySselector ( '#p2' )); 2 Render all at once HTML < div id = "app" ></ div > CSS . person { display : inline - block ; margin : 1...

Binary Tree Traversal in Python - In Order, Pre Order, Post Order

Binary Tree Traversal in Python - In Order, Pre Order, Post Order Run the code here to see output:  https://repl.it/@VinitKhandelwal/iterative-traversal-of-binary-tree # Node Class to Create Object of Nodes class Node (): def __init__ ( self , value , left= None , right= None ): self .value = value self .left = left self .right = right # Creation of a Binary Tree class BinaryTree (): def __init__ ( self , mylist ): self .mylist = mylist self .root=Node ( None ) for value in self .mylist : self .curr= self .root self ._add ( value ) def _add ( self , value ): if self .curr.value == None : self .curr.value = value else : if self .curr.value > value : if self .curr.left == None : self .curr.left = Node ( value ) else : self .curr = self .curr.left self ._add ( value ) else : if self...