Метод delete класса APIRouter
Метод delete применяется к экземпляру класса APIRouter
и вешает функцию на DELETE-запрос.
Первым параметром передаётся путь URL.
Вторым и последующими параметрами могут идти
зависимости, теги, статус-коды и прочие настройки маршрута.
Функция возвращает словарь, список или модель,
которые FastAPI отдаёт как JSON.
Синтаксис
router.delete(path)
Пример
Давайте создадим роутер и повесим обработчик на адрес '/items/{item_id}':
from fastapi import FastAPI, APIRouter
app = FastAPI()
router = APIRouter()
@router.delete('/items/{item_id}')
def delete_item(item_id: int):
return {'item_id': item_id, 'deleted': True}
app.include_router(router)
Результат выполнения кода для адреса /items/5:
{"item_id": 5, "deleted": true}
Пример
Давайте зададим префикс и тег для роутера, чтобы сгруппировать маршруты:
from fastapi import FastAPI, APIRouter
app = FastAPI()
router = APIRouter(prefix='/users', tags=['users'])
@router.delete('/{user_id}')
def delete_user(user_id: int):
return {'user_id': user_id, 'status': 'deleted'}
app.include_router(router)
Результат выполнения кода для адреса /users/10:
{"user_id": 10, "status": "deleted"}
