Метод get класса APIRouter

Метод get применяется к экземпляру класса APIRouter и вешает функцию на GET-запрос. Первым параметром передаётся путь URL. Функция возвращает словарь, список или модель, которые FastAPI отдаёт как JSON. Роутер затем подключается к приложению через метод include_router.

Синтаксис

router.get(path)

Пример

Давайте создадим роутер и повесим обработчик на адрес '/':

from fastapi import APIRouter

router = APIRouter()

@router.get('/')
def index():
	return {'text': 'hello'}

Подключим роутер к приложению:

from fastapi import FastAPI
from routers.index import router

app = FastAPI()

app.include_router(router)

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

{"text": "hello"}

Пример

Давайте примем параметр name из URL внутри роутера:

from fastapi import APIRouter

router = APIRouter()

@router.get('/user/{name}')
def user(name: str):
	return {'name': name}

Подключим роутер к приложению:

from fastapi import FastAPI
from routers.user import router

app = FastAPI()

app.include_router(router)

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

{"name": "abcde"}

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

класс APIRouter,
который группирует маршруты в отдельный роутер
метод post,
который вешает обработчик на POST-запрос
метод include_router,
который подключает роутер к приложению
метод api_route,
который вешает обработчик на произвольный HTTP-метод