Graphql Expert Best Practices

What it does

This skill provides a comprehensive guide to optimizing GraphQL APIs and adhering to best practices. It offers rules for resolver optimization, query performance, data fetching patterns, and schema design, prioritized by impact. The goal is to facilitate automated refactoring and code generation for improved backend services and API workflows.

When to use it

• When writing GraphQL schemas, resolvers, or type definitions.
• During the implementation of data fetching and resolver logic.
• When reviewing existing GraphQL code for performance issues.
• To guide refactoring efforts on existing GraphQL APIs.
• For designing the architecture of a GraphQL server.

Key capabilities

• Prioritized Rules: Provides rules categorized by priority (Critical, High, Medium) to focus optimization efforts.
• Resolver Optimization: Guidance on optimizing resolver performance and preventing N+1 issues using DataLoader.
• Schema Design Best Practices: Recommendations for schema design including identifier stability, structured types, role-based type splitting, and deprecation preferences.
• Mutation Design Guidelines: Rules for designing mutations around explicit actions, separating input types, and implementing type-safe error handling.
• Pagination Strategies: Advice on pagination implementation, specifically avoiding default totalCount.
• Security Considerations: Includes rules to prevent vulnerabilities like NoSQL injection and information leakage.

Example prompts

• "What are the best practices for schema design in GraphQL?"
• "How can I optimize query performance in my GraphQL API?"
• "Give me advice on designing mutations with type-safe error handling."
• "What is the 'dataloader-n-plus-one' rule and how do I apply it?"

Tips & gotchas

• The skill prioritizes rules based on impact, so focus on higher priority categories first.
• Be aware of security considerations when designing your GraphQL API, particularly regarding filtering and data leakage.
• This skill is focused on best practices for GraphQL, not general backend development or coding assistance.