快速开始

添加依赖

[dependencies]
async-graphql = "4.0"
async-graphql-actix-web = "4.0" # 如果你需要集成到 Actix-web
async-graphql-warp = "4.0" # 如果你需要集成到 Warp
async-graphql-tide = "4.0" # 如果你需要集成到 Tide

写一个 Schema

一个 GraphQL 的 Schema 包含一个必须的查询 (Query) 根对象,可选的变更 (Mutation) 根对象和可选的订阅 (Subscription) 根对象,这些对象类型都是用 Rust 语言的结构来描述它们,结构的字段对应 GraphQL 对象的字段。

Async-graphql 实现了常用数据类型到 GraphQL 类型的映射,例如i32, f64, Option<T>, Vec<T>等。同时,你也能够扩展这些基础类型,基础数据类型在 GraphQL 里面称为标量。

下面是一个简单的例子,我们只提供一个查询,返回ab的和。

#![allow(unused)]
fn main() {
extern crate async_graphql;
use async_graphql::*;

struct Query;

#[Object]
impl Query {
    /// Returns the sum of a and b
    async fn add(&self, a: i32, b: i32) -> i32 {
        a + b
    }
}

}

执行查询

在我们这个例子里面,只有 Query,没有 Mutation 和 Subscription,所以我们用EmptyMutationEmptySubscription来创建 Schema,然后调用Schema::execute来执行查询。

#![allow(unused)]
fn main() {
extern crate async_graphql;
use async_graphql::*;

struct Query;
#[Object]
impl Query {
  async fn version(&self) -> &str { "1.0" }    
}
async fn other() {
let schema = Schema::new(Query, EmptyMutation, EmptySubscription);
let res = schema.execute("{ add(a: 10, b: 20) }").await;
}
}

把查询结果输出为 JSON

let json = serde_json::to_string(&res);

和 Web Server 的集成

请参考 https://github.com/async-graphql/examples。