async-graphql/README.md

89 lines
2.7 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" />
2020-04-05 08:22:13 +00:00
<!-- codecov -->
<img src="https://codecov.io/gh/sunli829/async-graphql/branch/master/graph/badge.svg" />
2020-03-01 13:56:14 +00:00
<!-- 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>
2020-03-12 09:21:49 +00:00
`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.
2020-03-21 07:11:46 +00:00
* [Docs](https://docs.rs/async-graphql)
2020-03-01 13:56:14 +00:00
* [GitHub repository](https://github.com/sunli829/async-graphql)
* [Cargo package](https://crates.io/crates/async-graphql)
* Minimum supported Rust version: 1.42 or later
2020-03-01 13:56:14 +00:00
2020-03-09 12:44:31 +00:00
## Example
```shell script
cargo run --example actix_web
2020-03-09 12:44:31 +00:00
```
2020-03-09 12:45:11 +00:00
Open `http://localhost:8000` in browser
2020-03-09 12:44:31 +00:00
2020-04-02 07:51:04 +00:00
## Benchmark
```shell script
git clone https://github.com/sunli829/graphql-benchmark
cargo run --release
```
2020-03-02 00:24:49 +00:00
## Features
2020-03-17 11:11:14 +00:00
* Fully support async/await
* Type safety
* Rustfmt friendly (Procedural Macro)
* Custom scalar
* Minimal overhead
* Easy integration (hyper, actix_web, tide ...)
* Upload files (Multipart request)
2020-03-20 03:56:08 +00:00
* Subscription (WebSocket transport)
2020-03-26 03:34:28 +00:00
* Custom extension
* Apollo Tracing extension
* Limit query complexity/depth
2020-03-29 16:00:56 +00:00
* Error Extensions
2020-04-10 02:26:08 +00:00
* Apollo Federation
2020-03-20 03:56:08 +00:00
2020-03-18 00:44:41 +00:00
## Integrations
* Actix-web [async-graphql-actix-web](https://crates.io/crates/async-graphql-actix-web)
2020-03-18 00:44:41 +00:00
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)
2020-03-19 09:20:12 +00:00
* [GraphQL Multipart Request](https://github.com/jaydenseric/graphql-multipart-request-spec)
* [GraphQL Cursor Connections Specification](https://facebook.github.io/relay/graphql/connections.htm)
* [GraphQL over WebSocket Protocol](https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md)
2020-03-26 03:34:28 +00:00
* [Apollo Tracing](https://github.com/apollographql/apollo-tracing)
2020-04-10 02:28:27 +00:00
* [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction)
2020-03-22 08:45:59 +00:00
## Contribute
Welcome to contribute !