在flask中返回HTTP状态码201

Question

我们正在使用 Flask 作为我们的 API 之一，我只是想知道是否有人知道如何返回 HTTP 响应 201？

对于 404 之类的错误，我们可以调用：

from flask import abort
abort(404)

但是对于 201 我得到

LookupError：201也不例外

我是否需要创建自己的异常，例如 this在文档中？

Answer 1

您可以使用 Response 返回任何 http 状态代码。

> from flask import Response
> return Response("{'a':'b'}", status=201, mimetype='application/json')

Answer 2

您可以在此处阅读相关内容。

return render_template('page.html'), 201

Answer 3

您可以这样做

result = {'a': 'b'}
return result, 201

如果您想在响应中返回 JSON 数据以及错误代码，
您可以在此处和此处了解 make_response API 详细信息

Answer 4

由于返回语句中缺少建议的发送状态代码
如果您将其存储在某个变量中，例如

notfound = 404
invalid = 403
ok = 200

使用

return xyz, notfound

时间，请确保其类型是 int 而不是 str。当我遇到这个小问题时
这里还有全球遵循的状态代码列表
http://www.w3.org/Protocols/HTTP/HTRESP.html

希望有帮助。

Answer 5

在您的 Flask 代码中，理想情况下您还应该尽可能多地指定 MIME 类型：

return html_page_str, 200, {'ContentType':'text/html'}

return json.dumps({'success':True}), 200, {'ContentType':'application/json'}

...等

Answer 6

抄袭Luc的在此处评论，但返回空白响应，例如201 最简单的选项是在路由中使用以下返回。

return "", 201

例如：

    @app.route('/database', methods=["PUT"])
    def database():
        update_database(request)
        return "", 201

Answer 7

您还可以使用flask_api发送响应，

from flask_api import status

@app.route('/your-api/')
def empty_view(self):
    content = {'your content here'}
    return content, status.HTTP_201_CREATED

您可以在这里找到参考 http://www.flaskapi .org/api-guide/status-codes/

Answer 8

就我而言，我必须将上述内容结合起来才能使其发挥作用

return Response(json.dumps({'Error': 'Error in payload'}), 
status=422, 
mimetype="application/json")

Answer 9

根据 API 的创建方式，通常使用 201（已创建），您将返回已创建的资源。例如，如果它正在创建一个用户帐户，您将执行以下操作：

return {"data": {"username": "test","id":"fdsf345"}}, 201

请注意，后缀数字是返回的状态代码。

或者，您可能想向客户端发送消息，例如：

return {"msg": "Created Successfully"}, 201

Answer 10

对于错误 404，您可以获得

def post():
    #either pass or get error 
    post = Model.query.get_or_404()
    return jsonify(post.to_json())

201 成功

def new_post():
    post = Model.from_json(request.json)
    return jsonify(post.to_json()), 201, \
      {'Location': url_for('api.get_post', id=post.id, _external=True)}

Answer 11

您只需在返回数据后添加状态代码，如下所示：

from flask import Flask

app = Flask(__name__)
@app.route('/')
def hello_world():  # put application's code here
    return 'Hello World!',201
if __name__ == '__main__':
    app.run()

这是一个基本的 Flask 项目。启动后，您会发现当我们请求 http://127.0.0.1:5000/ 时，您将从网络浏览器控制台获得状态 201。

Answer 12

因此，如果您使用 API 的 flask_restful 包
返回 201 会变得像

def bla(*args, **kwargs):
    ...
    return data, 201

其中 data 应该是任何可散列/ JsonSerialable 值，如字典、字符串。

Answer 13

根据最新的 Flask 版本 3.0.2 使用类似的内容

return render_template('main.html', status=201, data=data)#where main.html 是模板名称，data 是要传递给模板的变量