Метод put
Метод put применяется к приложению
FastAPI и вешает функцию на PUT-запрос.
Первым параметром передаётся путь URL.
Функция возвращает словарь, список или модель,
которые FastAPI отдаёт как JSON.
PUT обычно используется для полного обновления
существующего ресурса.
Синтаксис
@app.put(path)
Пример
Давайте повесим обработчик на адрес '/user':
from fastapi import FastAPI
app = FastAPI()
@app.put('/user')
def update_user():
return {'text': 'user updated'}
Результат выполнения кода:
{"text": "user updated"}
Пример
Давайте примем параметр name из URL:
<+python+>
from fastapi import FastAPI
app = FastAPI()
@app.put('/user/{name}')
def update_user(name: str):
return {'name': name}
<-python+>
Результат выполнения кода для адреса /user/abcde:
{"name": "abcde"}
Пример
Давайте примем тело запроса через модель Pydantic:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class User(BaseModel):
name: str
age: int
@app.put('/user')
def update_user(user: User):
return {'name': user.name, 'age': user.age}
Результат выполнения кода для тела запроса {"name": "abcde", "age": 25}:
{"name": "abcde", "age": 25}