Обзор API
Базовый URL, два транспорта (REST и tRPC), Swagger и формат данных.
4 мин чтения#api#обзор#openapi#swagger
SmartDelivery предоставляет HTTP API поверх бэкенда на Express 5. Один и тот же сервер отдаёт два транспорта:
- REST (
/api/*) — классические JSON-эндпоинты для заказов, кухни, настроек и справочников. - tRPC (
/api/trpc) — типобезопасный транспорт, который использует веб-клиент (дашборд, маркетинг, отзывы, поддержка).
Инфо
Если вы пишете внешнюю интеграцию — начните с REST. tRPC удобнее, когда клиент тоже на TypeScript и может переиспользовать типы роутера.
Базовый URL
Адрес сервера задаётся переменной окружения NEXT_PUBLIC_API_URL в клиенте. По умолчанию:
# локальная разработка http://localhost:3001 # продакшн https://api.smartdelivery.ru
Формат данных
- Тело запросов и ответов —
application/json; charset=utf-8. - Даты — строки в ISO 8601 (
2026-06-05T12:30:00.000Z). - Денежные суммы — числа в рублях (не в копейках).
Интерактивная документация (Swagger)
Полная OpenAPI 3.0 спецификация со всеми REST-эндпоинтами, схемами и кнопкой «Try it out» доступна прямо на сервере:
GET
/api-docs— Интерактивный Swagger UIGET
/api-docs/swagger.json— Сырая OpenAPI-спека (JSON)Совет
swagger.json можно импортировать в Postman или Insomnia, чтобы за минуту получить готовую коллекцию запросов.