331 个版本 (稳定)

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.6.11 2020年3月31日

#1318 in 网络编程

Download history 7984/week @ 2024-05-02 7085/week @ 2024-05-09 7443/week @ 2024-05-16 7465/week @ 2024-05-23 10780/week @ 2024-05-30 10053/week @ 2024-06-06 8174/week @ 2024-06-13 8385/week @ 2024-06-20 8225/week @ 2024-06-27 6903/week @ 2024-07-04 6267/week @ 2024-07-11 10366/week @ 2024-07-18 10837/week @ 2024-07-25 10799/week @ 2024-08-01 10177/week @ 2024-08-08 11224/week @ 2024-08-15

45,240 每月下载量
用于 17 个 crate(9 个直接使用)

MIT/Apache

1MB
28K SLoC

async-graphql

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

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


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

此 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 友好(过程宏)
  • 自定义标量
  • 最小开销
  • 易于集成(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 追踪扩展
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 集成。
unblock 支持异步上传读取器
uuid uuid crate集成。
url url crate集成。

可观测性

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

谁在生产中使用 async-graphql

社区展示

博客文章

参考资料

许可证

根据以下任一许可授权:


lib.rs:

Async-graphql 与 Actix-web 集成

依赖关系

~22–34MB
~608K SLoC