142 lines
3.6 KiB
Markdown
142 lines
3.6 KiB
Markdown
# The GraphQL server library implemented by rust
|
|
|
|
<div align="center">
|
|
<!-- CI -->
|
|
<img src="https://github.com/sunli829/potatonet/workflows/CI/badge.svg" />
|
|
<!-- Crates version -->
|
|
<a href="https://crates.io/crates/async-graphql">
|
|
<img src="https://img.shields.io/crates/v/async-graphql.svg?style=flat-square"
|
|
alt="Crates.io version" />
|
|
</a>
|
|
<!-- Downloads -->
|
|
<a href="https://crates.io/crates/async-graphql">
|
|
<img src="https://img.shields.io/crates/d/async-graphql.svg?style=flat-square"
|
|
alt="Download" />
|
|
</a>
|
|
<!-- docs.rs docs -->
|
|
<a href="https://docs.rs/async-graphql">
|
|
<img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
|
|
alt="docs.rs docs" />
|
|
</a>
|
|
</div>
|
|
|
|
`async-graphql` is a GraphQL server library that fully supports async/await and is easy to use.
|
|
|
|
It supports all of the GraphQL specifications and is easy to integrate into existing web servers.
|
|
|
|
## Documentation
|
|
|
|
* [GitHub repository](https://github.com/sunli829/async-graphql)
|
|
* [Cargo package](https://crates.io/crates/async-graphql)
|
|
* Minimum supported Rust version: 1.40 or later
|
|
|
|
## Example
|
|
|
|
```shell script
|
|
cargo run --example actix-web
|
|
```
|
|
|
|
Open `http://localhost:8000` in browser
|
|
|
|
## Features
|
|
|
|
* Fully support async/await
|
|
* Type safety
|
|
* Rustfmt friendly (Procedural Macro)
|
|
* Custom scalar
|
|
* Minimal overhead
|
|
* Easy integration (hyper, actix_web, tide ...)
|
|
* Upload files (Multipart request)
|
|
* Subscription (WebSocket transport)
|
|
|
|
## Goals
|
|
|
|
- [X] Types
|
|
- [X] Scalar
|
|
- [X] Integer
|
|
- [X] Float
|
|
- [X] String
|
|
- [X] Bool
|
|
- [X] ID
|
|
- [X] DateTime
|
|
- [X] UUID
|
|
- [X] Containers
|
|
- [X] List
|
|
- [X] Non-Null
|
|
- [X] Object
|
|
- [X] Lifetime cycle
|
|
- [X] Enum
|
|
- [X] InputObject
|
|
- [X] Field default value
|
|
- [X] Deprecated flag
|
|
- [X] Interface
|
|
- [X] Union
|
|
- [X] Query
|
|
- [X] Fields
|
|
- [X] Arguments
|
|
- [X] Default value
|
|
- [X] Deprecated flag
|
|
- [X] Alias
|
|
- [X] Fragments
|
|
- [X] Inline fragments
|
|
- [X] Operation name
|
|
- [X] Variables
|
|
- [X] Default value
|
|
- [X] Parse value
|
|
- [X] Directives
|
|
- [X] @include
|
|
- [X] FIELD
|
|
- [X] FRAGMENT_SPREAD
|
|
- [X] INLINE_FRAGMENT
|
|
- [X] @skip
|
|
- [X] FIELD
|
|
- [X] FRAGMENT_SPREAD
|
|
- [X] INLINE_FRAGMENT
|
|
- [X] Schema
|
|
- [X] Multipart Request (https://github.com/jaydenseric/graphql-multipart-request-spec)
|
|
- [X] Actix-web
|
|
- [X] Subscription
|
|
- [X] Filter
|
|
- [X] WebSocket transport
|
|
- [X] Validation rules
|
|
- [X] ArgumentsOfCorrectType
|
|
- [X] DefaultValuesOfCorrectType
|
|
- [X] FieldsOnCorrectType
|
|
- [X] FragmentsOnCompositeTypes
|
|
- [X] KnownArgumentNames
|
|
- [X] KnownDirectives
|
|
- [X] KnownFragmentNames
|
|
- [X] KnownTypeNames
|
|
- [X] LoneAnonymousOperation
|
|
- [X] NoFragmentCycles
|
|
- [X] NoUndefinedVariables
|
|
- [X] NoUnusedFragments
|
|
- [X] NoUnusedVariables
|
|
- [X] OverlappingFieldsCanBeMerged
|
|
- [X] PossibleFragmentSpreads
|
|
- [X] ProvidedNonNullArguments
|
|
- [X] ScalarLeafs
|
|
- [X] UniqueArgumentNames
|
|
- [X] UniqueFragmentNames
|
|
- [X] UniqueOperationNames
|
|
- [X] UniqueVariableNames
|
|
- [X] VariablesAreInputTypes
|
|
- [X] VariableInAllowedPosition
|
|
- [ ] Integration examples
|
|
- [X] Actix-web
|
|
- [ ] Hyper
|
|
- [X] Tide
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
* Apache License, Version 2.0,
|
|
(./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
|
|
* MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT)
|
|
at your option.
|
|
|
|
## References
|
|
|
|
* [GraphQL](https://graphql.org)
|