静态模式

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
• 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

博客文章

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

参考

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

许可

根据以下任一许可进行许可：

• Apache License，版本2.0，（LICENSE-APACHE或http://www.apache.org/licenses/LICENSE-2.0）
• MIT许可（LICENSE-MIT或http://opensource.org/licenses/MIT）由您选择。