Функция Form
Функция Form применяется внутри функции-обработчика
в качестве значения по умолчанию для параметра.
Она указывает FastAPI, что значение нужно брать
из данных формы, отправленных клиентом,
а не из строки запроса или тела JSON.
Первым параметром передаётся значение по умолчанию,
например ... для обязательного поля.
Дополнительные параметры настраивают валидацию и описание поля.
Синтаксис
Form(default, *, alias, title, description, gt, ge, lt, le, min_length, max_length, pattern, deprecated, examples, media_type)
Пример
Давайте примем два поля формы на адресе '/login':
from fastapi import FastAPI, Form
app = FastAPI()
@app.post('/login')
def login(username: str = Form(...), password: str = Form(...)):
return {'username': username, 'password': password}
Результат выполнения кода при отправке формы:
{"username": "user", "password": "abcde"}
Пример
Давайте зададим значение по умолчанию и ограничение длины для поля формы:
<+python+>
from fastapi import FastAPI, Form
app = FastAPI()
@app.post('/article')
def create_article(title: str = Form('article', min_length=3, max_length=100)):
return {'title': title}
<-python+>
Результат выполнения кода без отправки поля title:
{"title": "article"}
Смотрите также
-
функция
File,
которая принимает файлы из формы -
функция
Body,
которая принимает данные из тела запроса -
функция
Query,
которая принимает параметры из строки запроса -
параметр
media_type,
который задаёт тип содержимого поля формы
