https://github.com/dotansimha/graphql-tools-rs
https://github.com/dotansimha/graphql-tools-rs
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dotansimha/graphql-tools-rs
- Owner: dotansimha
- Created: 2021-12-05T14:25:35.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T19:18:25.000Z (about 1 year ago)
- Last Synced: 2024-10-29T19:55:37.392Z (about 1 year ago)
- Language: Rust
- Size: 628 KB
- Stars: 40
- Watchers: 9
- Forks: 3
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## `graphql-tools` (Rust)
[Documentation](https://docs.rs/graphql-tools) | [Crate](https://crates.io/crates/graphql-tools) | [GitHub](https://github.com/dotansimha/graphql-tools-rs)
The [`graphql_tools` crate](https://crates.io/crates/graphql-tools) implements tooling around GraphQL for Rust libraries. Most of the tools are based on `trait`s and `struct`s implemented in [`graphql_parser` crate](https://crates.io/crates/graphql-parser).
The goal of this library is to create a common layer of tools that has similar/improved APIs to [`graphql-js` reference implementation](https://github.com/graphql/graphql-js) and [`graphql-tools` from the JS/TS ecosystem](https://github.com/ardatan/graphql-tools).
### Getting Started
Add `graphql-tools` as a dependency of your project by adding the following to your `Cargo.toml` file:
```toml
[dependencies]
graphql-tools = "..."
```
Or, if you are using [`cargo-edit`](https://github.com/killercup/cargo-edit):
```
cargo add graphql-tools
```
By default, this crate is using the [`graphql-parser`](https://github.com/graphql-rust/graphql-parser) library for parsing. If you wish to use an alternative implementation such as [`graphql-hive/graphql-parser-hive-fork`](https://github.com/graphql-hive/graphql-parser-hive-fork), use the following `features` setup:
```toml
[dependencies]
graphql-tools = { version = "...", features = "graphql_parser_fork", default-features = false }
```
#### Validation Rules
> This comparison is based on `graphql-js` reference 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)