2020-04-15 09:19:26 +00:00
|
|
|
|
# 快速开始
|
|
|
|
|
|
|
|
|
|
## 添加依赖
|
|
|
|
|
|
|
|
|
|
```toml
|
|
|
|
|
[dependencies]
|
|
|
|
|
async-graphql = "1.9.0"
|
2020-04-22 03:16:41 +00:00
|
|
|
|
async-graphql-actix-web = "1.0.0" # 如果你需要集成到Actix-web
|
|
|
|
|
async-graphql-warp = "1.0.0" # 如果你需要集成到Warp
|
2020-04-15 09:19:26 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 写一个Schema
|
|
|
|
|
|
2020-04-16 02:22:57 +00:00
|
|
|
|
一个GraphQL的Schema包含一个必须的查询(Query)根对象,可选的变更(Mutation)根对象和可选的订阅(Subscription)根对象,这些对象类型都是用Rust语言的结构来描述它们,结构的字段对应GraphQL对象的字段,但你需要用`#[field]`来修饰它,这样`Async-graphql`提供的过程宏才能够正确的识别它。
|
2020-04-15 09:19:26 +00:00
|
|
|
|
|
|
|
|
|
Async-graphql实现了常用数据类型到GraphQL类型的映射,例如`i32`, `f64`, `Option<T>`, `Vec<T>`等。同时,你也能够[扩展这些基础类型](custom_scalars.md),基础数据类型在GraphQL里面称为标量。
|
|
|
|
|
|
|
|
|
|
下面是一个简单的例子,我们只提供一个查询,返回`a`和`b`的和。
|
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
use async_graphql::*;
|
|
|
|
|
|
|
|
|
|
struct Query;
|
|
|
|
|
|
|
|
|
|
#[Object]
|
|
|
|
|
impl Query {
|
|
|
|
|
#[field(desc = "Returns the sum of a and b")]
|
|
|
|
|
async fn add(a: i32, b: i32) -> i32 {
|
|
|
|
|
a + b
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-16 02:22:57 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 执行查询
|
|
|
|
|
|
2020-04-22 03:16:41 +00:00
|
|
|
|
在我们这个例子里面,只有Query,没有Mutation和Subscription,所以我们用`EmptyMutation`和`EmptySubscription`来创建Schema,然后调用`Schema::execute`来执行查询。
|
2020-04-15 09:19:26 +00:00
|
|
|
|
|
2020-04-16 02:22:57 +00:00
|
|
|
|
```rust
|
|
|
|
|
let schema = Schema::new(MySchema, EmptyMutation, EmptySubscription);
|
|
|
|
|
let res = schema.execute("{ add(a: 10, b: 20) }");
|
2020-04-15 09:19:26 +00:00
|
|
|
|
```
|
|
|
|
|
|
2020-04-16 02:22:57 +00:00
|
|
|
|
## 把查询结果输出为JSON
|
|
|
|
|
|
2020-04-22 03:16:41 +00:00
|
|
|
|
查询返回的`async_graphql::Result`用`async_graphql::http::GQLResponse`包装起来,就能直接转换为JSON。
|
2020-04-16 02:22:57 +00:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
let json = serde_json::to_vec(async_graphql::http::GQLResponse(res));
|
2020-04-22 03:16:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 和Web Server的集成
|
|
|
|
|
|
2020-04-28 07:41:31 +00:00
|
|
|
|
请参考https://github.com/async-graphql/examples。
|