97个稳定版本

7.0.7 2024年7月14日
7.0.5 2024年5月9日
7.0.4 2024年3月30日
6.0.11 2023年11月19日
2.11.3 2021年11月13日

#1687 in 网络编程

Download history 899/week @ 2024-04-25 920/week @ 2024-05-02 1006/week @ 2024-05-09 1152/week @ 2024-05-16 877/week @ 2024-05-23 790/week @ 2024-05-30 1182/week @ 2024-06-06 1198/week @ 2024-06-13 852/week @ 2024-06-20 673/week @ 2024-06-27 612/week @ 2024-07-04 657/week @ 2024-07-11 558/week @ 2024-07-18 867/week @ 2024-07-25 744/week @ 2024-08-01 568/week @ 2024-08-08

2,834 每月下载
5 crates 中使用

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(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集成。
url url集成。

可观测性

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

哪些生产环境中使用 async-graphql

社区展示

博客文章

参考文献

许可证

根据您选择,许可为以下之一


lib.rs:

Async-graphql 与 Poem 的集成

依赖项

约 20–32MB
约 547K SLoC