Параметр status_code
Параметр status_code применяется к декораторам маршрутов
приложения FastAPI и задаёт HTTP-код статуса,
который будет возвращён вместе с ответом обработчика.
По умолчанию FastAPI использует код 200.
В качестве значения можно передать как целое число,
так и константу из модуля status.
Синтаксис
@app.get(path, status_code=200)
Пример
Давайте зададим код 201 для обработчика создания ресурса:
from fastapi import FastAPI, status
app = FastAPI()
@app.post('/items', status_code=status.HTTP_201_CREATED)
def create_item():
return {'text': 'created'}
Результат выполнения кода для POST-запроса на адрес /items:
{"text": "created"}
Пример
Давайте вернём код 204 для успешного удаления без тела ответа:
from fastapi import FastAPI, status
app = FastAPI()
@app.delete('/items/{item_id}', status_code=status.HTTP_204_NO_CONTENT)
def delete_item(item_id: int):
return None
Результат выполнения кода для DELETE-запроса на адрес /items/1 - пустой ответ с кодом 204.
Смотрите также
-
метод
post,
который вешает обработчик на POST-запрос -
метод
delete,
который вешает обработчик на DELETE-запрос -
параметр
responses,
который описывает дополнительные коды ответов в документации -
параметр
response_model,
который задаёт модель ответа обработчика
