使用Flask-Restful引发自定义错误

Question

全部,我正在尝试使用Flask-Restful,按照文档提出自定义错误.出于测试目的,我已经在文档中定义并注册了错误词典中的链接:api = flask_restful.Api(app, errors=errors).

但是,当我想abort(409)在资源模块中使用(例如)引发自定义错误时,firebug会报告:

{"message":"冲突","状态":409}

这似乎是标准的409错误,没有定制; 从文档中,我希望自定义错误消息 - "具有该用户名的用户已存在".

我想我错过了引发错误本身的一些事情.我应该以任何方式使用字典密钥吗？尽管我尝试过,但检查Flask-Restful源代码并没有帮助.

Answer 1

要定义一个标准的消息HTTP状态代码与瓶的RESTful,必须重新定义所提供的HTTP例外之一WERKZEUG,其上合剂为基础的.

根据您的问题,这是一个覆盖Conflict异常的示例:

errors = {
    'Conflict': {
        'message': "A user with that username already exists.",
        'status': 409,
    },
}

app = Flask(__name__)
api = flask_restful.Api(app, errors=errors)

因此,每次调用时abort(409),这将返回正确的mediatype中的表示,并返回已定义的消息.

但是,通过使用此方法,您将在任何地方中止409状态代码,这将返回有关已存在用户名的用户的消息.当您abort(409)在处理除用户之外的其他资源的视图中调用时,这不太可能.

因此,我建议您在每次要提供自定义消息时,只需使用Flask-RESTfulabort方法,如下所示:

from flask.ext.restful import abort

abort(409, description="A user with that username already exists.")

一般来说,通过定义自定义错误消息来扩展Flask-RESTful非常有用,当您引发raise()不在Werkzeug提供abort()的HTTP异常中的自定义异常(有,而不是)时.