Перейти к основному содержимому

Эндпоинты и HTTP-запросы

Раздел Endpoints в окне Python Frameworks собирает маршруты Django, DRF, Django Ninja, Flask и FastAPI в одно дерево. Список строится из кода, приложение запускать не нужно.

Окно Python Frameworks: проект rw-django, раскрыт раздел Endpoints со 104 маршрутами; маршруты сгруппированы по приложениям checklists, fundraising, members, urls, weblog, у каждого пометка ANY, путь с переменными Django в угловых скобках и имя обработчика

Маршруты проекта с методом, путём и обработчиком. У маршрутов Django, где метод в коде не задан, стоит ANY.

Список маршрутов​

  • Метод, путь и обработчик. Там, где фреймворк задаёт метод, показаны GET, POST, PUT, PATCH или DELETE. Путь показан целиком, с префиксом роутера или blueprint — например, /api/v1/users/{user_id}.
  • Группировка — по приложению, blueprint или роутеру.
  • Переход к коду. Двойной щелчок открывает функцию или класс маршрута.
  • Дубликат маршрута. Два маршрута с одним методом и путём подчёркиваются.

В редакторе маршрут помечен значком на полях, а URL показан подсказкой рядом с обработчиком. От теста значок ведёт к маршруту, который он проверяет.

Запрос в Connekt​

От маршрута в дереве генерируется готовый запрос и дописывается в скрипт Connekt, HTTP-клиента OpenIDE.

Окно Python Frameworks слева: модели Pydantic RideCreate и Station с полями, раздел Endpoints с четырьмя маршрутами, выделен POST /rides. Справа скрипт api-requests-velopark.connekt.kts: baseUrl из окружения, запрос POST на $baseUrl/rides с JSON-телом station_id, minutes, is_member. Внизу в окне запуска — ответ сервера с полями id, started_at и cost

Запрос POST /rides сгенерирован из дерева: тело собрано по модели RideCreate, внизу — ответ сервера.

  • Базовый адрес. baseUrl хранится в connekt.env.json и подставляется в каждый запрос.
  • Тело для POST, PUT и PATCH. JSON собирается по модели Pydantic или сериализатору DRF, значения — примеры по типам полей.
  • Переменные пути становятся слотами запроса: и {id} у FastAPI, и <int:pk> у Django.
  • Повтор. Если такой метод и путь в скрипте уже есть, IDE спросит, перезаписать запрос или добавить ещё один.

Тест для маршрута​

Заготовка теста создаётся прямо от эндпоинта в дереве.

Экспорт OpenAPI​

Спецификация OpenAPI 3.1 собирается из кода без запуска сервера и сохраняется в scratch/openapi.yaml.