AIKraft/Skills/VTEX IO: HTTP-маршруты

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.

vtex official Дизайн

Что делает навык

Навык применяется при проектировании и реализации HTTP-эндпоинтов в VTEX IO через service.json и узлы Node. Он обеспечивает явные контракты запросов и ответов, структурирует обработчики и middleware, а также стандартизирует валидацию и формирование статус-кодов.

Когда применять

  • Создание callback или webhook-эндпоинтов с явными URL-контрактами.
  • Экспозиция интеграционных эндпоинтов для партнёров или backoffice-потоков.
  • Структурирование цепочек middleware и границ обработчиков маршрутов.
  • Валидация параметров, query-строк, заголовков или тел запросов.
  • Стандартизация формы ответа и поведения статус-кодов для семейств маршрутов.

Как работает

  1. Объявите маршруты в service.json, указав ID, пути и уровень доступа (public).
  2. Создайте файлы обработчиков в node/routes/, группируя их по доменам (например, orders.ts).
  3. В node/routes/index.ts сопоставьте ID маршрутов из service.json с экспортированными функциями-обработчиками.
  4. Реализуйте логику валидации входных данных и формирования ответа непосредственно в обработчиках.
  5. Вынесите повторяющиеся проверки (auth, нормализация) в отдельные middleware и объедините их через compose.
  6. Обеспечьте bounded latency маршрутов, перенеся тяжёлые или пакетные задачи в асинхронные потоки (events/workers).

Примеры запросов агенту

Спроектируй HTTP-маршрут для получения заказа по ID с валидацией параметра и обработкой ошибок.
Реализуй middleware для проверки подписи запроса и примени его к вебхуку в VTEX IO.
Создай маршрут-триггер для импорта данных, который возвращает 202 Accepted и запускает фоновую задачу.

Описание составлено по SKILL.md навыка, сверено 05.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «vtex-io-http-routes» из репозитория: # https://github.com/vtex/skills
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r vtex-io-http-routes/ ~/.claude/skills/vtex-io-http-routes/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.