vtex-io-graphql-api

Expose data through a GraphQL API in VTEX IO apps with schemas, resolvers, and directives.

39|9|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/vtexdocs/ai-skills --skill vtex-io-graphql-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-graphql-api
Source: https://github.com/vtexdocs/ai-skills/tree/main/tracks/vtex-io/skills/vtex-io-graphql-api
Command: npx skills add https://github.com/vtexdocs/ai-skills --skill vtex-io-graphql-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Exposes a production-ready GraphQL API in VTEX IO apps by providing structured schemas, resolvers, and directives, reducing boilerplate and setup time.

Core Features & Use Cases

  • Defines GraphQL schemas in the graphql directory and wires resolvers in node/resolvers to the Service entry point.
  • Enforces authentication and caching with @auth and @cacheControl on appropriate fields, and supports resolver wiring across the Service.
  • Guides proper project structure, builder declarations, and resolver-name alignment to ensure a functioning GraphQL API in VTEX IO apps.

Quick Start

Set up a VTEX IO app by placing your GraphQL schema in graphql/, implement resolvers under node/resolvers/, declare the graphql builder in manifest.json, and wire everything into the Service entry point.

Frequently Asked Questions about vtex-io-graphql-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a GraphQL API in a VTEX IO app?

To build a GraphQL API in a VTEX IO app, place your schema in the graphql/ directory, implement resolvers under node/resolvers/, declare the graphql builder in manifest.json, and wire everything into the Service entry point.

How do I add authentication and caching to VTEX IO GraphQL resolvers?

You add authentication and caching to VTEX IO GraphQL resolvers by applying the @auth and @cacheControl directives directly on appropriate fields within your schema definitions.

Why are my VTEX IO GraphQL resolvers not working?

VTEX IO GraphQL resolvers fail when resolver names do not match schema fields or the graphql builder is missing from manifest.json. Ensure resolver names align with schema fields and the builder is declared.

When do I need to declare the graphql builder in VTEX IO?

You need to declare the graphql builder in VTEX IO whenever your app requires a combined schema and resolver wiring to expose queries and mutations through a Service entry point.

What is the best way to expose data safely through a VTEX IO GraphQL API?

The best way to expose data safely through a VTEX IO GraphQL API is by implementing data access via ctx.clients combined with proper authentication and caching directives on your schema fields.