python - 我可以在 restplus 模型旁边显示用户定义的错误消息吗？

Question

我编写了一个提供 API 的 Flask 应用程序。我正在使用 RESTplus 库。

我使用一个模型来格式化数据。如果请求成功，则将值插入模型并返回模型。但是，如果请求不成功，则返回模型并且所有值为 null。我的目标是返回包含多个键值对的用户定义的错误消息。错误消息的结构应该与模型不同。

这是一个最小的例子:

from flask import Flask
from flask_restplus import Resource, fields, Api


app = Flask(__name__)

api = Api()
api.init_app(app)


books = {'1': {"id": 1, "title": "Learning JavaScript Design Patterns", 'author': "Addy Osmani"},
         '2': {"id": 2, "title": "Speaking JavaScript", "author": "Axel Rauschmayer"}}

book_model = api.model('Book', {
    'id': fields.String(),
    'title': fields.String(),
    'author': fields.String(),
})

@api.route('/books/<id>')
class ApiBook(Resource):

    @api.marshal_with(book_model)
    def get(self, id):
        try:
            return books[id]
        except KeyError as e:
            return {'message': 'Id does not exist'}

if __name__ == '__main__':
    app.run()

成功输出

curl -X GET "http://127.0.0.1:5000/books/1"-H "accept: application/json"

{
  "id": "1",
  "title": "Learning JavaScript Design Patterns",
  "author": "Addy Osmani"
}

错误输出

curl -X GET "http://127.0.0.1:5000/books/3"-H "accept: application/json"

{
  "id": null,
  "title": null,
  "author": null
}

是否可以在模型旁边显示用户定义的错误消息？有替代方案吗？

Answer 1

不要在get方法中捕获异常然后返回一个对象；您从该方法返回的任何内容都将使用该模型进行编码。

相反，请遵循 error handling documentation并使用 flask.abort() 设置一个带有消息的 404 响应:

# at the top of your module
from flask import abort

# in the resource class
@api.marshal_with(book_model)
def get(self, id):
    try:
        return books[id]
    except KeyError as e:
        raise abort(404, 'Id does not exist')

你给 abort() 的第二个参数会自动变成一个带有 message 键的 JSON 对象，所以 {"message": "Id does not exist ".

您还可以为 KeyError 异常创建一个 @api.errorhandler 注册并将其转换为 404 响应:

@api.errorhandler(KeyError)
def handle_keyerror(error):
    return {"message": f"Object with id {error} could not be found"}, 404

然后不要在您的get() 方法中捕获异常:

@api.marshal_with(book_model)
def get(self, id):
    return books[id]

请注意，当 ERROR_404_HELP 设置为 True(默认值)时，RestPlus 会将消息添加到备选路线建议中，附加到每个 404 响应中:

curl -X GET "http://127.0.0.1:5000/books/3" -H "accept: application/json"
{
    "message": "Object with id '3' could not be found. You have requested this URI [/books/3] but did you mean /books/<id> ?"
}

这对您的具体情况可能没有太大帮助，因此您可能希望禁用 ERROR_404_HELP。