#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

#101 in HTTP server

Download history 932/week @ 2024-06-23 960/week @ 2024-06-30 595/week @ 2024-07-07 1581/week @ 2024-07-14 1235/week @ 2024-07-21 985/week @ 2024-07-28 985/week @ 2024-08-04 850/week @ 2024-08-11 810/week @ 2024-08-18 950/week @ 2024-08-25 992/week @ 2024-09-01 927/week @ 2024-09-08 939/week @ 2024-09-15 785/week @ 2024-09-22 758/week @ 2024-09-29 857/week @ 2024-10-06

3,375 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.2–3MB
~67K SLoC