graphql-schema
Installation
Summary
Industry best practices guide for designing intuitive, performant, and maintainable GraphQL schemas.
- Covers core design principles including client-centric type organization, explicit nullability patterns, and backwards-compatible evolution strategies
- Provides reference documentation on types, naming conventions, cursor-based pagination, error modeling, and security considerations
- Includes practical patterns for interfaces, unions, input types, mutations, and ID strategies with code examples
- Emphasizes ground rules for descriptions, non-null fields, list patterns, and avoiding breaking changes through deprecation
SKILL.md
GraphQL Schema Design Guide
This guide covers best practices for designing GraphQL schemas that are intuitive, performant, and maintainable. Schema design is primarily a server-side concern that directly impacts API usability.
Schema Design Principles
1. Design for Client Needs
- Think about what queries clients will write
- Organize types around use cases, not database tables
- Expose capabilities, not implementation details
2. Be Explicit
- Use clear, descriptive names
- Make nullability intentional
- Document with descriptions
3. Design for Evolution
Related skills