Question

我仅用一种方法构建了一个小的Flask-Restful API。我的API会收到一个单词和一个URL列表，并为每个URL返回给定单词的出现次数。

from flask import Flask, request, jsonify
from flask_restful import Resource, Api
import sys
sys.path.append("..")

from word_count import WordCount


app = Flask(__name__)
api = Api(app=app)

class WordApp(Resource):
    def get(self):
        word = request.args.get('word')
        url = request.args.get('url').split(",")
        return {'data': WordCount(url, word).count_words()}


api.add_resource(WordApp, '/')

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

如果请求的资源调用成功，则返回的内容为

{"data": {"foo": {"http://www.foobar.com": 42}}}

尽管，如果请求调用失败，则返回的内容不符合JSON API，如docs中所述：

包含“状态”键将设置响应的状态代码。如果不指定它将默认为500。

错误内容：

{"message": "Internal Server Error"}

搜索时发现that可以定义一个包含每个错误的字典并将其传递给Api对象。

errors = {
    'INVALID_FIELD': {
        'message': "Missing or invalid field",
        'status': 400
    }
}

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

但是，使用具有以下设置的Postman测试我的终结点，会返回相同的500错误消息。我想我的实现中缺少一些东西，以便返回我的自定义错误消息。

http://127.0.0.1:5000/?word=to

我想根据JSON API规范返回正确的自定义错误消息，如下所示：

{
    "error": {
        "message": "Missing or invalid field",
        "code": 400
    }
}

Answer 1

在有错误的字典中，您使用键INVALID_FIELD。但是，您不能自己选择此值。如果查看werkzeug文档https://werkzeug-docs-cn.readthedocs.io/zh_CN/latest/exceptions.html，您会发现每个异常都是一个类。

因此，您应该使用INVALID_FIELD而不是BadRequest，它是与错误代码400对应的类的名称。

将Flask-Restful API调整为JSON API规范

1 个答案: