Атрибут path_params
Атрибут path_params принадлежит классу Request
и хранит словарь параметров пути.
Он доступен внутри функции-обработчика через объект запроса.
Ключами словаря являются имена параметров из шаблона URL,
а значениями - строки, извлечённые из фактического адреса.
Синтаксис
request.path_params
Пример
Давайте получим параметр пути через атрибут path_params:
from fastapi import FastAPI, Request
app = FastAPI()
@app.get('/user/{name}')
def user(request: Request):
return {'name': request.path_params['name']}
Результат выполнения кода для адреса /user/abcde:
{"name": "abcde"}
Пример
Давайте вернём весь словарь параметров пути целиком:
from fastapi import FastAPI, Request
app = FastAPI()
@app.get('/user/{name}/article/{id}')
def user(name: str, id: int, request: Request):
return request.path_params
Результат выполнения кода для адреса /user/abcde/article/1:
{"name": "abcde", "id": "1"}
Обратите внимание: значения в словаре всегда строки,
даже если параметр объявлен как int.
Смотрите также
-
класс
Request,
который представляет входящий HTTP-запрос -
атрибут
query_params,
который хранит параметры строки запроса -
атрибут
url,
который возвращает объект URL запроса -
атрибут
path,
который возвращает путь запроса