Skip to main content

Flask REST API error handling best practices?

I am writing a Flask REST API. When a request is received, the API calls functions to interact with a database.

Currently, i am catching errors with try: except: statements and then returning custom http responses based off of the raised exception.

However, i just learned of the @errorhandler decorator. Rather than writing repeated try: except: statements, should i instead write a number of custom error classes, and then assign each class to an @errorhandler. Then within my code, remove the try: except: statements and raise the custom errors when neccessary?

Current code:

from flask import Flask, jsonify, request

app = Flask(__name__)


@app.route('/example', methods=['POST'])
    def create_user():
        try:
            data = request.get_json()
            # Call example function to interact with database
            response = db_example(data=data)
            return response
        except (KeyError, Exception):
            response = jsonify({"error": "example error message"})
            response.status_code = 400
            return response
        
# Example function to interact with database
def db_example(data):
    try:
        # Connect to database
        # Execute query
        # Handle result data etc...
        response = jsonify({"success": "example success message"})
        response.status_code = 200
        return response
    except (KeyError, Exception):
        # Unexpected error raised
        response = jsonify({"error": "example error message"})
        response.status_code = 500
        return response

Or is the below code considered better practice?

from flask import Flask, jsonify, request

app = Flask(__name__)

# Class for custom errors
class APIError(Exception):
    """ ALL CUSTOM EXCEPTIONS """
    code = 400
    description = "Invalid data"


@app.errorhandler(APIError)
    def handle_exception(err):
        response = jsonify({"error": err.description})
        response.status_code = err.code
        return response


@app.route('/example', methods=['POST'])
def create_user():
    data = request.get_json()
    # Call example function to interact with database
    response = db_example(data=data)
    return response

# Example function to interact with database
def db_example(data):
    success = False
    # Connect to database
    # Execute query
    # Handle result data etc...
    if success
        response = jsonify({"success": "example success message"})
        response.status_code = 200
    else:
        raise APIError



source https://stackoverflow.com/questions/75700666/flask-rest-api-error-handling-best-practices

Comments

Popular posts from this blog

Why is my reports service not connecting?

I am trying to pull some data from a Postgres database using Node.js and node-postures but I can't figure out why my service isn't connecting. my routes/index.js file: const express = require('express'); const router = express.Router(); const ordersCountController = require('../controllers/ordersCountController'); const ordersController = require('../controllers/ordersController'); const weeklyReportsController = require('../controllers/weeklyReportsController'); router.get('/orders_count', ordersCountController); router.get('/orders', ordersController); router.get('/weekly_reports', weeklyReportsController); module.exports = router; My controllers/weeklyReportsController.js file: const weeklyReportsService = require('../services/weeklyReportsService'); const weeklyReportsController = async (req, res) => { try { const data = await weeklyReportsService; res.json({data}) console...

How to show number of registered users in Laravel based on usertype?

i'm trying to display data from the database in the admin dashboard i used this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count(); echo $users; ?> and i have successfully get the correct data from the database but what if i want to display a specific data for example in this user table there is "usertype" that specify if the user is normal user or admin i want to user the same code above but to display a specific usertype i tried this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count()->WHERE usertype =admin; echo $users; ?> but it didn't work, what am i doing wrong? source https://stackoverflow.com/questions/68199726/how-to-show-number-of-registered-users-in-laravel-based-on-usertype

The number of nodes and edges I calculated manually and by a method provided by networkx library dont match

I am trying to analyse a graph using networkx library in Python. I have implemented a function that returns the nodes and edges of that graph. After that I counted the number of nodes and edges by implementing the len() function for nodes and edges, which gave me 17 for both nodes and edges. However, when I used the method graph.number_of_nodes() of networkx library it gave me 53. My code: import pandas as pd import networkx as nx import matplotlib.pyplot as plt header_list = ["a","b","w"] E =pd.read_csv("aves-barn-swallow-contact-network.edges",sep=" ",header= None,names=header_list) # print(E.head()) # prints first few rows of the csv file G = nx.from_pandas_edgelist(E,"a","b",["w"]) nx.draw(G) plt.show() class GraphAnalyse: #finding nodes and edges def nodeEdge(self,Graph): nodes = Graph.nodes() edges = Graph.edges() ...