graphql-tools-rs

graphql-tools-rs copied to clipboard

graphql-tools (Rust)

Documentation | Crate | GitHub

Note: this crate is still under development (see roadmap below)

The graphql_tools crate implements tooling around GraphQL for Rust libraries. Most of the tools are based on traits and structs implemented in graphql_parser crate.

The goal of this library is to create a common layer of tools that has similar/improved APIs to graphql-js reference implementation and graphql-tools from the JS/TS ecosystem.

Getting Started

Add graphql-tools as a dependency of your project by adding the following to your Cargo.toml file:

[dependencies]
graphql-tools = "..."

Or, if you are using cargo-edit:

cargo add graphql-tools

Roadmap and progress

• [ ] Better documentation
• [x] AST Visitor for GraphQL schema (graphql_parser::schema::Document)
• [x] AST Visitor for GraphQL operations (graphql_parser::operation::Document)
• [x] AST Visitor with TypeInfo
• [x] AST tools (ongoing)
• [x] struct extensions
• [x] GraphQL Validation engine
• [x] Validation rules
• [x] GraphQL operations transformer

If you have an idea / missing feature, feel free to open an issue / start a GitHub discussion!

Validation Rules

This comparison is based on graphql-js refernece implementation.

• [x] ExecutableDefinitions (not actually needed)
• [x] UniqueOperationNames
• [x] LoneAnonymousOperation
• [x] SingleFieldSubscriptions
• [x] KnownTypeNames
• [x] FragmentsOnCompositeTypes
• [x] VariablesAreInputTypes
• [x] LeafFieldSelections
• [x] FieldsOnCorrectType
• [x] UniqueFragmentNames
• [x] KnownFragmentNames
• [x] NoUnusedFragments
• [x] PossibleFragmentSpreads
• [x] NoFragmentCycles
• [x] UniqueVariableNames
• [x] NoUndefinedVariables
• [x] NoUnusedVariables
• [x] KnownDirectives
• [x] UniqueDirectivesPerLocation
• [x] KnownArgumentNames
• [x] UniqueArgumentNames
• [x] ValuesOfCorrectType
• [x] ProvidedRequiredArguments
• [x] VariablesInAllowedPosition
• [x] OverlappingFieldsCanBeMerged
• [ ] UniqueInputFieldNames (blocked by https://github.com/graphql-rust/graphql-parser/issues/59)