VTEX IO: HTTP-маршруты
Apply when designing or implementing HTTP endpoints exposed by a VTEX IO backend service. Covers route boundaries, handler structure, middleware composition, request validation, and response modeling for service.json routes. Use for webhook endpoints, partner integrations, callback APIs, or reviewing VTEX IO handlers that should expose explicit HTTP contracts.
Что делает навык
Навык применяется при проектировании и реализации HTTP-эндпоинтов в VTEX IO через service.json и узлы Node. Он обеспечивает явные контракты запросов и ответов, структурирует обработчики и middleware, а также стандартизирует валидацию и формирование статус-кодов.
Когда применять
- Создание callback или webhook-эндпоинтов с явными URL-контрактами.
- Экспозиция интеграционных эндпоинтов для партнёров или backoffice-потоков.
- Структурирование цепочек middleware и границ обработчиков маршрутов.
- Валидация параметров, query-строк, заголовков или тел запросов.
- Стандартизация формы ответа и поведения статус-кодов для семейств маршрутов.
Как работает
- Объявите маршруты в service.json, указав ID, пути и уровень доступа (public).
- Создайте файлы обработчиков в node/routes/, группируя их по доменам (например, orders.ts).
- В node/routes/index.ts сопоставьте ID маршрутов из service.json с экспортированными функциями-обработчиками.
- Реализуйте логику валидации входных данных и формирования ответа непосредственно в обработчиках.
- Вынесите повторяющиеся проверки (auth, нормализация) в отдельные middleware и объедините их через compose.
- Обеспечьте bounded latency маршрутов, перенеся тяжёлые или пакетные задачи в асинхронные потоки (events/workers).
Примеры запросов агенту
Описание составлено по SKILL.md навыка, сверено 05.10.2026.
Как подключить
SKILL.md к навыкам ассистентаНавык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.