#graphql #ast #validation #gql #tool

graphql-tools

Tools for working with GraphQL in Rust, based on graphql-parser Document

27 releases

0.2.5 Feb 15, 2024
0.2.3 Jan 29, 2024
0.2.2 Feb 13, 2023
0.2.1 Dec 5, 2022
0.0.9 Dec 28, 2021

#44 in HTTP server

Download history 293/week @ 2023-12-18 320/week @ 2023-12-25 266/week @ 2024-01-01 582/week @ 2024-01-08 512/week @ 2024-01-15 554/week @ 2024-01-22 500/week @ 2024-01-29 560/week @ 2024-02-05 913/week @ 2024-02-12 824/week @ 2024-02-19 667/week @ 2024-02-26 619/week @ 2024-03-04 921/week @ 2024-03-11 1121/week @ 2024-03-18 867/week @ 2024-03-25 1337/week @ 2024-04-01

4,297 downloads per month

MIT/Apache

495KB
13K SLoC

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

Crates.io

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
  • AST Visitor for GraphQL schema (graphql_parser::schema::Document)
  • AST Visitor for GraphQL operations (graphql_parser::operation::Document)
  • AST Visitor with TypeInfo
  • AST tools (ongoing)
  • struct extensions
  • GraphQL Validation engine
  • Validation rules
  • 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.

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

Dependencies

~2.3–3MB
~70K SLoC