Функция Query
Функция Query применяется внутри функции-обработчика
FastAPI и объявляет параметр строки запроса.
Она позволяет задать значение по умолчанию,
ограничения валидации и метаданные параметра.
Первым аргументом передаётся значение по умолчанию,
а через именованные аргументы задаются дополнительные настройки.
Синтаксис
Query(default, alias, title, description, gt, ge, lt, le, min_length, max_length, pattern, deprecated)
Пример
Давайте примем параметр name из строки запроса:
from fastapi import FastAPI, Query
app = FastAPI()
@app.get('/user')
def user(name: str = Query('abcde')):
return {'name': name}
Результат выполнения кода для адреса /user?name=article:
{"name": "article"}
Пример
Давайте зададим ограничение длины и описание для параметра name:
from fastapi import FastAPI, Query
app = FastAPI()
@app.get('/user')
def user(name: str = Query('abcde', min_length=2, max_length=10, description='user name')):
return {'name': name}
Результат выполнения кода для адреса /user?name=hello:
{"name": "hello"}
