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 异步

Download history 4427/week @ 2024-04-23 5285/week @ 2024-04-30 4252/week @ 2024-05-07 4866/week @ 2024-05-14 7135/week @ 2024-05-21 5247/week @ 2024-05-28 5481/week @ 2024-06-04 5987/week @ 2024-06-11 6566/week @ 2024-06-18 4934/week @ 2024-06-25 6129/week @ 2024-07-02 6139/week @ 2024-07-09 6356/week @ 2024-07-16 6408/week @ 2024-07-23 5494/week @ 2024-07-30 6094/week @ 2024-08-06

25,229 个月下载量
9 crate 中使用

MIT/Apache

1MB
27K SLoC

async-graphql

一个高性能、完全符合规范的 GraphQL 服务器库

书籍中文文档文档GitHub 仓库Cargo 包


ci status code coverage Unsafe Rust forbidden Crates.io version docs.rs docs downloads PRs Welcome

此 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 友好(过程宏)
  • 自定义标量
  • 最小开销
  • 易于集成(poemaxumactix-webtidewarprocket ...)
  • 上传文件(多部分请求)
  • 订阅(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服务器粘合在一起的方式,这里提供了一些,或者您也可以构建自己的!

包特性

此包提供以下特性。大多数特性默认未启用,除了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::RwLocktokio::sync::Mutex集成。
解除阻塞 支持异步上传读取器
uuid uuid crate集成。
url url crate集成。

可观测性

Apollo Studio是用于在生产环境中监控您的GraphQL服务器的工具之一。Apollo Studio是一个云平台,可帮助您构建、监控、验证和保障您组织的数据图。通过添加扩展crate async_graphql_apollo_studio_extension来实现此功能。

谁在生产中使用async-graphql

社区展示

博客文章

参考

许可

根据以下之一许可:


lib.rs:

Async-graphql与Warp的集成

依赖关系

~17–29MB
~488K SLoC