Мы используем Flask для одного из наших API, и мне просто интересно, знает ли кто-нибудь, как вернуть HTTP-ответ 201?
Для таких ошибок, как 404, мы можем позвонить:
from flask import abort
abort(404)
Но за 201 я получаю
LookupError: нет исключения для 201
Нужно ли мне создавать собственное исключение, например this, в документации?
Вы можете прочитать об этом здесь.
return render_template('page.html'), 201
Вы можете использовать Response, чтобы вернуть любой код статуса http.
> from flask import Response
> return Response("{'a':'b'}", status=201, mimetype='application/json')
Из-за недостатков предлагается отправить код состояния в операторе возврата, и если вы сохраняете его в какой-либо переменной, например
notfound = 404
invalid = 403
ok = 200
и используя
return xyz, notfound
чем время, убедитесь, что его тип - int, а не str. поскольку я столкнулся с этой небольшой проблемой, вот список кодов состояния, за которым следует глобально http://www.w3.org/Protocols/HTTP/HTRESP.html
Надеюсь, поможет.
status.NOT_FOUND
- person roshnet; 27.05.2021
Ты можешь сделать
result = {'a': 'b'}
return result, 201
если вы хотите вернуть данные JSON в ответе вместе с кодом ошибки. Вы можете прочитать об ответах здесь и здесь для подробностей API make_response
В идеале в коде фляги вы также должны как можно чаще указывать тип MIME:
return html_page_str, 200, {'ContentType':'text/html'}
return json.dumps({'success':True}), 200, {'ContentType':'application/json'}
...и т.д
вы также можете использовать 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/
В зависимости от того, как создается API, обычно с 201 (created) вы должны вернуть ресурс, который был создан. Например, если бы он создавал учетную запись пользователя, вы бы сделали что-то вроде:
return {"data": {"username": "test","id":"fdsf345"}}, 201
Обратите внимание, что номер с постфиксом - это возвращаемый код состояния.
В качестве альтернативы вы можете отправить клиенту сообщение, например:
return {"msg": "Created Successfully"}, 201
Срывая Люка комментарий здесь, но для возврата пустого ответа, такого как 201, самый простой вариант - использовать следующий возврат в вашем маршруте.
return "", 201
Так например:
@app.route('/database', methods=["PUT"])
def database():
update_database(request)
return "", 201
для ошибки 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)}
В моем случае мне пришлось объединить вышеперечисленное, чтобы заставить его работать
return Response(json.dumps({'Error': 'Error in payload'}),
status=422,
mimetype="application/json")
Итак, если вы используете flask_restful пакет для API, возвращающий 201 будет выглядеть как
def bla(*args, **kwargs):
...
return data, 201
где data должно быть любым хешируемым / JsonSerialiable значением, например dict, string.
