AIKraft/Skills/VTEX IO: GraphQL API

VTEX IO: GraphQL API

Apply when working with GraphQL schema files in graphql/ or implementing resolvers in node/resolvers/ for VTEX IO apps. Covers schema.graphql definitions, @cacheControl and @auth directives, custom type definitions, and resolver registration in the Service class. Use for exposing data through GraphQL queries and mutations with proper cache control and authentication enforcement.

vtex official Данные

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

Навык применяется для создания GraphQL API в приложениях VTEX IO, включая определение схем в директории /graphql и реализацию резолверов в TypeScript. Он обеспечивает корректное кэширование через директивы @cacheControl и защиту данных с помощью @auth, а также регистрирует резолверы в классе Service.

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

  • Разработка GraphQL API для фронтенд-компонентов React или других приложений VTEX IO.
  • Определение схем данных (Query, Mutation, кастомные типы) в файлах .graphql.
  • Настройка политик кэширования для публичных запросов и аутентификации для мутаций.
  • Реализация логики резолверов с использованием ctx.clients для доступа к данным VTEX.

Как работает

  1. Добавить директиву graphql: "1.x" в раздел builders файла manifest.json для обработки схемы.
  2. Создать структуру директорий /graphql с файлами schema.graphql, directives.graphql и каталогом types/.
  3. Определить типы Query и Mutation, добавив директивы @cacheControl для публичных Query и @auth для мутаций.
  4. Написать функции резолверов в TypeScript в директории /node/resolvers/, используя ctx.clients для доступа к данным.
  5. Связать резолверы с полями схемы в классе Service в файле node/index.ts, точно совпадая с именами полей.
  6. Проверить соответствие имен ключей резолверов именам полей в схеме для предотвращения молчаливых ошибок.

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

Создай GraphQL API для приложения VTEX IO с резолверами для получения списка отзывов и создания нового отзыва.
Настрой схему GraphQL с директивами @cacheControl для публичных запросов и @auth для мутаций в директории /graphql.
Реализуй резолверы в TypeScript, используя ctx.clients, и зарегистрируй их в классе Service, совпадая с именами полей схемы.

Что понадобится

  • Среда разработки VTEX IO с установленным CLI.
  • Доступ к манифесту приложения (manifest.json) для конфигурации билдеров.
  • Знание структуры директорий /graphql и /node/resolvers/.

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

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

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

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