How to correct response format for flask rest api?

Question

I'm developing a REST API with flask flask-restx. I want all my response will be formatted like this

{
"code": 200,
"status": "success",
"message": "OK",
"data": {
         
     }
}

from flask import request
from flask_restx import Resource
from ..service.quiz_services import QuizService
from ..utils.dto import QuizDto

api = QuizDto.api


@api.route("/")
class QuizController(Resource):
    def post(self):
        data = request.json
        return QuizService.create_quiz(data)

When do I make GET request on the following URL, it returns

{
    "message": "The method is not allowed for the requested URL."
}

which is expected as I don't have get method in the QuizController class, How can I customize this Error Message?

in the Flask file you have only `def post(self):` so if there is no GET function in `class QuizController(Resource):` it will return "The method is not allowed. Try to add before the post function: ` def get(self): return { "message": "OK", } `. You can put whatever you want in the return dictionary - JSON — Gandalf The Gray, Oct 09 '21 at 22:44

score 0 · Answer 1 · answered Nov 09 '21 at 13:50

You can catch for a specific exception on app-level

@app.errorhandler(Exception)
def catch_error(err):
    return "hello", 400

If you want to catch only 404 exceptions you can use this:

from werkzeug.exceptions import NotFound
@app.errorhandler(NotFound)
def catch_error(err):
    return "hello", 400

How to correct response format for flask rest api?

1 Answers1