Параметр default

Параметр default применяется в функциях объявления параметров запроса, таких как Path, Query, Header, Cookie, Body, Form и File. Он задаёт значение, которое FastAPI подставляет, если клиент не передал параметр в запросе. Благодаря этому параметр становится необязательным. Если значение по умолчанию не задано, параметр считается обязательным.

Значением default может быть число, строка, список, словарь, None или другой объект Python, совместимый с типом параметра.

Синтаксис

Query(default=value)

Аналогично для остальных функций объявления параметров: Path, Header, Cookie, Body, Form, File.

Пример

Давайте объявим необязательный query-параметр count со значением по умолчанию:

from fastapi import FastAPI, Query

app = FastAPI()

@app.get('/items/')
def items(count: int = Query(default=10)):
	return {'count': count}

Результат выполнения кода для адреса /items/:

{"count": 10}

А для адреса /items/?count=5 клиент переопределяет значение по умолчанию:

{"count": 5}

Пример

Давайте объявим необязательный параметр пути name со значением по умолчанию:

from fastapi import FastAPI, Path

app = FastAPI()

@app.get('/user/{name}')
def user(name: str = Path(default='guest')):
	return {'name': name}

Результат выполнения кода для адреса /user/abcde:

{"name": "abcde"}

Результат выполнения кода для адреса /user/:

{"name": "guest"}

Пример

Давайте объявим необязательный заголовок user-agent со значением по умолчанию:

from fastapi import FastAPI, Header

app = FastAPI()

@app.get('/agent/')
def agent(user_agent: str = Header(default='unknown')):
	return {'user_agent': user_agent}

Результат выполнения кода без заголовка:

{"user_agent": "unknown"}

Смотрите также

функция Query,
которая объявляет query-параметр запроса
функция Path,
которая объявляет параметр пути
параметр alias,
который задаёт альтернативное имя параметра
параметр description,
который задаёт описание параметра