async-graphql/README.md

123 lines
3.1 KiB
Markdown
Raw Normal View History

2020-03-01 13:56:14 +00:00
# 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>
## Documentation
* [GitHub repository](https://github.com/sunli829/async-graphql)
* [Cargo package](https://crates.io/crates/async-graphql)
* Minimum supported Rust version: 1.39 or later
2020-03-02 00:24:49 +00:00
## Features
* Fully support async/await.
* Type safety.
* Rustfmt friendly (Procedural Macro).
* Custom scalar.
* Minimal overhead.
2020-03-03 11:25:20 +00:00
* Easy integration (hyper, actix_web, tide ...).
2020-03-02 00:24:49 +00:00
2020-03-01 14:13:37 +00:00
## Goals
2020-03-09 04:18:21 +00:00
- [X] Types
2020-03-01 14:13:37 +00:00
- [X] Scalar
- [X] Integer
- [X] Float
- [X] String
- [X] Bool
2020-03-01 16:59:04 +00:00
- [X] ID
2020-03-01 14:13:37 +00:00
- [X] DateTime
- [X] UUID
2020-03-03 11:17:48 +00:00
- [X] Containers
2020-03-01 14:13:37 +00:00
- [X] List
- [X] Non-Null
2020-03-09 10:05:52 +00:00
- [X] Object
2020-03-04 02:38:07 +00:00
- [X] Lifetime cycle
2020-03-01 14:13:37 +00:00
- [X] Enum
2020-03-01 17:09:21 +00:00
- [X] InputObject
2020-03-04 02:38:07 +00:00
- [X] Field default value
2020-03-03 03:48:00 +00:00
- [X] Deprecated flag
2020-03-07 02:43:09 +00:00
- [X] Interface
2020-03-08 01:21:29 +00:00
- [X] Union
2020-03-05 09:06:14 +00:00
- [X] Query
2020-03-01 14:13:37 +00:00
- [X] Fields
- [X] Arguments
2020-03-04 02:38:07 +00:00
- [X] Default value
2020-03-03 03:48:00 +00:00
- [X] Deprecated flag
2020-03-01 16:52:38 +00:00
- [X] Alias
2020-03-05 09:06:14 +00:00
- [X] Fragments
- [X] Inline fragments
2020-03-01 14:13:37 +00:00
- [X] Operation name
2020-03-01 16:52:05 +00:00
- [X] Variables
2020-03-04 02:38:07 +00:00
- [X] Default value
2020-03-03 11:15:18 +00:00
- [X] Parse value
2020-03-05 09:06:14 +00:00
- [X] Directives
- [X] @include
- [X] FIELD
2020-03-05 09:06:14 +00:00
- [X] FRAGMENT_SPREAD
- [X] INLINE_FRAGMENT
- [X] @skip
- [X] FIELD
2020-03-05 09:06:14 +00:00
- [X] FRAGMENT_SPREAD
- [X] INLINE_FRAGMENT
2020-03-03 11:17:48 +00:00
- [X] Schema
2020-03-05 09:06:14 +00:00
- [ ] Validation rules
2020-03-08 12:58:22 +00:00
- [X] ArgumentsOfCorrectType
- [X] DefaultValuesOfCorrectType
2020-03-09 04:08:50 +00:00
- [X] FieldsOnCorrectType
- [X] FragmentsOnCompositeTypes
- [X] KnownArgumentNames
2020-03-08 12:58:22 +00:00
- [ ] KnownDirectives
2020-03-09 04:08:50 +00:00
- [X] KnownFragmentNames
2020-03-09 10:05:52 +00:00
- [X] KnownTypeNames
- [X] LoneAnonymousOperation
2020-03-09 04:08:50 +00:00
- [X] NoFragmentCycles
2020-03-09 10:05:52 +00:00
- [X] NoUndefinedVariables
- [X] NoUnusedFragments
2020-03-09 12:39:46 +00:00
- [X] NoUnusedVariables
2020-03-08 12:58:22 +00:00
- [ ] OverlappingFieldsCanBeMerged
- [ ] PossibleFragmentSpreads
- [ ] ProvidedNonNullArguments
- [ ] ScalarLeafs
2020-03-09 12:39:46 +00:00
- [X] UniqueArgumentNames
- [X] UniqueFragmentNames
2020-03-08 12:58:22 +00:00
- [ ] UniqueInputFieldNames
- [ ] UniqueOperationNames
- [ ] UniqueVariableNames
- [ ] VariableInAllowedPosition
2020-03-05 09:06:14 +00:00
- [ ] Integration examples
2020-03-05 06:37:16 +00:00
- [X] Actix-web
2020-03-03 11:25:20 +00:00
- [ ] Hyper
- [X] Tide
2020-03-03 03:48:00 +00:00
## 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.
2020-03-01 14:13:37 +00:00
2020-03-01 13:56:14 +00:00
## References
* [GraphQL](https://graphql.org)