188个版本 (稳定版)
7.0.7 | 2024年7月14日 |
---|---|
7.0.5 | 2024年5月9日 |
7.0.3 | 2024年3月16日 |
6.0.11 | 2023年11月19日 |
0.5.1 | 2020年5月18日 |
#194 in 网络编程
478,741 每月下载量
在 211 个crate中使用了(直接使用27个)
235KB
4K SLoC
async-graphql
一个高性能、完全符合规范的GraphQL服务器库
书籍 • 中文文档 • 文档 • GitHub仓库 • Cargo包
此crate使用 #![forbid(unsafe_code)]
确保所有内容都在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跟踪扩展。 |
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 集成。 |
unblock |
支持异步上传读取器 |
uuid |
与uuid 包集成。 |
url |
与url 包集成。 |
可观察性
在生产环境中监控您的graphql服务所使用的工具之一是Apollo Studio。Apollo Studio是一个云平台,帮助您构建、监控、验证和保障组织的数据图。通过添加扩展包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 基于TAO的简单框架,Facebook的社交图分布式数据库。
- vimwiki-server 提供graphql服务器以检查和操作vimwiki文件。
- Diana Diana是Rust的一个GraphQL系统,设计得尽可能简单,同时不牺牲配置能力。
- cindythink
- sudograph
博客文章
参考
- GraphQL
- GraphQL Multipart请求
- GraphQL订阅的多部分HTTP协议
- GraphQL游标连接规范
- WebSocket协议上的GraphQL
- Apollo Tracing
- Apollo Federation
许可证
许可方式任选其一
- Apache License 2.0(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
- MIT许可证(LICENSE-MIT 或 http://opensource.org/licenses/MIT)
lib.rs
:
GraphQL解析器。用于async-graphql
包。
它使用pest包解析输入并将其转换为Rust类型。
依赖项
~3-4MB
~78K SLoC