vtex-io-graphql-api

To set up a VTEX IO GraphQL API, declare the graphql builder in manifest.json, organize .graphql files for schema types, and register TypeScript resolvers through the Service entry point with keys matching schema fields exactly.

VTEX IO GraphQL resolvers fail when resolver keys do not exactly match the schema field names defined in your .graphql files. Ensure your TypeScript resolver object keys are identical to the Query and Mutation field names.

You should not add @cacheControl to Mutations in a VTEX IO GraphQL schema. Caching is only applied to public Query fields to improve performance, while Mutations must remain uncached to ensure data integrity.

You can enforce authorization in VTEX IO GraphQL endpoints by applying the @auth directive to protected or sensitive fields. This ensures access is validated before executing the resolver logic for those operations.

Yes, you should use ctx.clients for data access inside VTEX IO GraphQL resolvers. This ensures consistent client instantiation and proper integration with external APIs and VTEX platform services.

The best way to secure and cache a VTEX IO GraphQL endpoint is to apply @cacheControl on public Query fields for performance and use @auth directives on sensitive operations, while routing data access through ctx.clients.