静态模式

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

crate特性

本crate提供以下特性。大多数特性默认未启用，除了GraphiQL (graphiql)和GraphQL Playground (playground)的集成。

可观察性

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
• 我的数据，我的同意

社区展示

• rust-actix-graphql-sqlx-postgresql 使用Rust和Apollo Federation进行GraphQL
• entity-rs 基于 TAO，Facebook 的社交图分布式数据库的一个简单框架。
• vimwiki-server 提供了用于检查和操作vimwiki文件的graphql服务器。
• Diana Diana是一个为Rust设计的GraphQL系统，旨在尽可能简单地工作，同时不牺牲配置能力。
• cindythink
• sudograph

博客文章

• Rust中的异步GraphQL
• Rust中的GraphQL
• 如何使用Rocket、GraphQL、PostgreSQL实现Rust微服务
• 在Lambda上使用Rust运行GraphQL

参考文献

• GraphQL
• GraphQL Multipart Request
• GraphQL订阅的多部分HTTP协议
• GraphQL游标连接规范
• WebSocket协议上的GraphQL
• Apollo Tracing
• Apollo Federation

许可证

根据以下任一许可证授权

• Apache许可证，版本2.0，(LICENSE-APACHE或https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT许可证(LICENSE-MIT或http://opensource.org/licenses/MIT)，由您选择。

lib.rs:

Async-graphql与Rocket集成。

注意：此集成与未发布的Rocket 0.5版本，因此可以预期此库和Rocket都将有破坏性变更。

要配置发送和接收多部分请求的选项，请将您的MultipartOptions实例添加到Rocket管理的状态中（.manage(your_multipart_options)）。

完整示例