263 个稳定版本
7.0.7 | 2024 年 7 月 14 日 |
---|---|
7.0.5 | 2024 年 5 月 9 日 |
7.0.3 | 2024 年 3 月 16 日 |
6.0.11 | 2023 年 11 月 19 日 |
1.16.10 | 2020 年 7 月 17 日 |
#1715 in 异步
25,229 个月下载量
在 9 crate 中使用
1MB
27K SLoC
async-graphql
一个高性能、完全符合规范的 GraphQL 服务器库
书籍 • 中文文档 • 文档 • GitHub 仓库 • Cargo 包
此 crate 使用 #![forbid)]
来确保所有内容都在 100% 安全的 Rust 中实现。
静态模式
use std::error::Error;
use async_graphql::{http::GraphiQLSource, EmptyMutation, EmptySubscription, Object, Schema};
use async_graphql_poem::*;
use poem::{listener::TcpListener, web::Html, *};
struct Query;
#[Object]
impl Query {
async fn howdy(&self) -> &'static str {
"partner"
}
}
#[handler]
async fn graphiql() -> impl IntoResponse {
Html(GraphiQLSource::build().finish())
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
// create the schema
let schema = Schema::build(Query, EmptyMutation, EmptySubscription).finish();
// start the http server
let app = Route::new().at("/", get(graphiql).post(GraphQL::new(schema)));
println!("GraphiQL: https://127.0.0.1:8000");
Server::new(TcpListener::bind("0.0.0.0:8000"))
.run(app)
.await?;
Ok(())
}
动态模式
需要启用 dynamic-schema
功能。
use std::error::Error;
use async_graphql::{dynamic::*, http::GraphiQLSource};
use async_graphql_poem::*;
use poem::{listener::TcpListener, web::Html, *};
#[handler]
async fn graphiql() -> impl IntoResponse {
Html(GraphiQLSource::build().finish())
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
let query = Object::new("Query").field(Field::new(
"howdy",
TypeRef::named_nn(TypeRef::STRING),
|_| FieldFuture::new(async { "partner" }),
));
// create the schema
let schema = Schema::build(query, None, None).register(query).finish()?;
// start the http server
let app = Route::new().at("/", get(graphiql).post(GraphQL::new(schema)));
println!("GraphiQL: https://127.0.0.1:8000");
Server::new(TcpListener::bind("0.0.0.0:8000"))
.run(app)
.await?;
Ok(())
}
功能
- 完全支持静态和动态模式
- 完全支持 async/await
- 类型安全
- Rustfmt 友好(过程宏)
- 自定义标量
- 最小开销
- 易于集成(poem、axum、actix-web、tide、warp、rocket ...)
- 上传文件(多部分请求)
- 订阅(WebSocket 传输)
- 自定义扩展
- 错误扩展
- 限制查询复杂度/深度
- 批查询
- Apollo 持久查询
- Apollo 追踪扩展
- Apollo 联邦(v2)
注意:最低支持的 Rust 版本:1.75.0 或更高版本
示例
所有示例都在 子仓库 中,位于 examples 目录下。
git submodule update # update the examples repo
cd examples && cargo run --bin [name]
更多信息,请参阅子存储库的README.md。
集成
集成是将async-graphql
与您的Web服务器粘合在一起的方式,这里提供了一些,或者您也可以构建自己的!
- Poem async-graphql-poem
- Actix-web async-graphql-actix-web
- Warp async-graphql-warp
- Tide async-graphql-tide
- Rocket async-graphql-rocket
- Axum async-graphql-axum
包特性
此包提供以下特性。大多数特性默认未启用,除了GraphiQL(graphiql
)和GraphQL Playground(playground
)的集成。
特性 | 启用 |
---|---|
apollo_tracing |
启用Apollo tracing扩展。 |
apollo_persisted_queries |
启用Apollo持久查询扩展。 |
bson |
与bson 包集成。 |
bigdecimal |
与bigdecimal 包集成。 |
cbor |
支持serde_cbor。 |
chrono |
与chrono 包集成。 |
chrono-tz |
与chrono-tz 包集成。 |
dataloader |
支持DataLoader。 |
decimal |
与rust_decimal 包集成。 |
dynamic-schema |
支持动态模式 |
fast_chemail |
与fast_chemail 包集成。 |
graphiql |
启用GraphiQL IDE集成 |
hashbrown |
与hashbrown 包集成。 |
log |
启用Logger扩展。 |
opentelemetry |
启用OpenTelemetry扩展。 |
playground |
启用GraphQL playground IDE集成 |
rawvalue |
支持来自serde_json 的原始值 |
secrecy |
与secrecy 包集成。 |
smol_str |
与smol_str 包集成。 |
string_number |
启用StringNumber。 |
time |
与time 包集成。 |
tracing |
启用Tracing扩展。 |
tempfile |
将上传的内容保存在临时文件中。 |
tokio-sync |
与tokio::sync::RwLock 和tokio::sync::Mutex 集成。 |
解除阻塞 |
支持异步上传读取器 |
uuid |
与uuid crate集成。 |
url |
与url crate集成。 |
可观测性
Apollo Studio是用于在生产环境中监控您的GraphQL服务器的工具之一。Apollo Studio是一个云平台,可帮助您构建、监控、验证和保障您组织的数据图。通过添加扩展crate async_graphql_apollo_studio_extension
来实现此功能。
谁在生产中使用async-graphql
?
- Vector
- DiveDB
- Kairos Sports tech
- AxieInfinity
- Nando's
- Prima.it
- VoxJar
- Zenly
- Brevz
- thorndyke
- My Data My Consent
社区展示
- rust-actix-graphql-sqlx-postgresql 使用Rust和Apollo Federation进行GraphQL
- entity-rs 基于 Facebook 的分布式数据库 TAO 的一种简单框架。
- vimwiki-server 提供GraphQL服务器以检查和操作vimwiki文件。
- Diana Diana是一个为Rust设计的GraphQL系统,旨在尽可能简单,同时不牺牲配置能力。
- cindythink
- sudograph
博客文章
参考
许可
根据以下之一许可:
- Apache License, Version 2.0, (LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT 或 http://opensource.org/licenses/MIT)任选其一。
lib.rs
:
Async-graphql与Warp的集成
依赖关系
~17–29MB
~488K SLoC