Overview
gql_build is a code generation package for GraphQL that provides builders to process GraphQL SDL (Schema Definition Language) and documents. It leverages the capabilities of gql_code_builder and the build system to generate Dart code from GraphQL schemas and queries, enabling type-safe interactions with GraphQL APIs. Designed for developers using GraphQL in Flutter or Dart applications, it streamlines schema and query management by automating code generation. The package supports multiple platforms including Android, iOS, macOS, Windows, and Linux.
Use cases
- Generating type-safe GraphQL clients
- Automating schema and query code generation
- Integrating GraphQL into Flutter apps
- Simplifying schema evolution
- Enabling compile-time validation of GraphQL queries
- Supporting large-scale GraphQL projects
Key features
- Generates Dart classes from GraphQL SDL
- Supports code generation for queries, mutations, and subscriptions
- Built on top of the build system for seamless integration
- Provides strong typing for GraphQL operations
- Offers extensibility through custom builders
- Ensures compatibility across multiple platforms
Suitable for
- Flutter developers using GraphQL
- Teams managing complex GraphQL schemas
- Projects requiring type safety in GraphQL usage
- Developers seeking automated code generation workflows
- Applications needing robust GraphQL client integration
Considerations
- Requires knowledge of the build system
- May increase build times with large schemas
- Depends on correct setup of build_runner
- Needs proper configuration in pubspec.yaml
- Limited to use with GraphQL schemas and documents
- Not suitable for runtime GraphQL parsing