Package selection guidance compiled from public package information, community data, and project usage.
gql_dio_link is a GraphQL terminating link for Dart that enables executing GraphQL requests using Dio, a powerful HTTP client. It integrates seamlessly with the gql-dart ecosystem, leveraging Dio’s robust features like interceptors, request/response transformation, and error handling. Designed for efficient JSON-based communication, it supports all major platforms including mobile, web, and desktop. Ideal for apps requiring flexible HTTP control and advanced networking capabilities within GraphQL workflows.
Use cases
Integrating GraphQL with custom HTTP logic
Using Dio's interceptors for authentication
Handling complex request/response transformations
Building cross-platform apps with shared network logic
Implementing retry mechanisms via Dio
Customizing headers and timeouts
Key features
Built on top of Dio for advanced HTTP control
Supports JSON-based GraphQL execution
Offers interceptors for middleware
Cross-platform compatibility
Easy integration with gql-dart
Configurable request/response handling
Suitable for
Developers using Dio in their projects
Apps needing fine-grained HTTP control
Teams building scalable GraphQL clients
Projects requiring platform-agnostic networking
Users wanting to extend GraphQL behavior with HTTP middleware
Considerations
Requires familiarity with Dio
Additional dependency overhead
May need manual setup for advanced configurations
Not ideal for simple HTTP use cases
Limited to JSON transport
Dependent on gql-dart ecosystem stability
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
gql-dart/gql
This is an effort to advance the Dart GraphQL ecosystem.
It consists of multiple packages and libraries centered around GraphQL AST.
Core
The core of this project is the GraphQL parser which parses GraphQL strings into an AST. The parsed AST can then be transformed, visited and printed back to GraphQL string.
To enable development of GraphQL clients, we provide type definitions used to execute GraphQL operations. They include AST-based operation, request with per operation context, and response. These types are used by the Links.
Link is the current client implementation. Link is GraphQL AST-aware request/response middleware. They can be used to build a pipeline to deduplicate requests, conditionally transform requests and responses (including the context), and eventually send the requests to the server.
The goal of this project is to expand Dart GraphQL ecosystem
and to build a community around this vendor-neutral implementation.
Community contributions are welcome.
Release Process
This repository uses Melos to manage the monorepo and handle releases. The release process is partially automated through GitHub Actions.
Repository Structure
The repository is organized into several package categories:
Core packages:
gql: Core GraphQL package
gql_tristate_value
gql_code_builder_serializers
gql_code_builder
Execution packages:
gql_exec
gql_link
Link implementations:
gql_http_link
gql_dio_link
gql_websocket_link
gql_dedupe_link
gql_error_link
gql_transform_link
Build packages:
gql_build
Local Development
To get started with local development:
Install Melos:
dart pub global activate melos && dart pub get
Bootstrap the workspace:
melos bootstrap
Run tests:
melos test
Release Process
Automated Publishing
The publish workflow is automated via GitHub Actions and triggers when:
Changes are pushed to the master or release branches AND include changes to any pubspec.yaml file
Manually triggered through GitHub Actions UI
The automated process:
Validates all packages (formatting, analysis, and tests)
Publishes packages in dependency order:
Core packages first
Execution packages second
Link implementation packages third
Build packages last
Manual Release Steps
To create a new release manually:
Ensure you're on the branch you want to release from (master or release)
Version the packages using one of the following commands:
# For a patch release
melos run bump-patch
# For a minor release
melos run bump-minor
# For a major release
melos run bump-major
# For an alpha release
melos run bump-alpha
# To graduate from prerelease(alpha) to stable
melos run graduate
Push the changes and tags:
git push && git push --tags
The GitHub Action will automatically handle publishing to pub.dev if changes include pubspec.yaml files
Versioning Rules
Use bump-patch for backward-compatible bug fixes
Use bump-minor for backward-compatible features
Use bump-major for breaking changes
Use bump-alpha for prerelease versions
Use graduate to promote prerelease versions to stable
Available Melos Commands
melos bootstrap: Set up the workspace
melos clean: Clean all packages
melos test: Run tests for all packages
melos format: Format all packages
melos analyze: Run static analysis
melos build: Run build_runner for all packages
melos publish: Publish packages to pub.dev
Troubleshooting
If the automated publish fails:
Check the GitHub Actions logs for specific errors
Ensure all tests are passing locally: melos test
Verify that version numbers in pubspec.yaml files are correct
Check that all dependencies are properly versioned
For manual publishing (if needed, requires pub dev authentication):