1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
//! # The GraphQL server library implemented by rust //! //! <div align="center"> //! <!-- CI --> //! <img src="https://github.com/sunli829/potatonet/workflows/CI/badge.svg" /> //! <!-- Crates version --> //! <a href="https://crates.io/crates/async-graphql"> //! <img src="https://img.shields.io/crates/v/async-graphql.svg?style=flat-square" //! alt="Crates.io version" /> //! </a> //! <!-- Downloads --> //! <a href="https://crates.io/crates/async-graphql"> //! <img src="https://img.shields.io/crates/d/async-graphql.svg?style=flat-square" //! alt="Download" /> //! </a> //! <!-- docs.rs docs --> //! <a href="https://docs.rs/async-graphql"> //! <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square" //! alt="docs.rs docs" /> //! </a> //! </div> //! //! ## Documentation //! //! * [GitHub repository](https://github.com/sunli829/async-graphql) //! * [Cargo package](https://crates.io/crates/async-graphql) //! * Minimum supported Rust version: 1.39 or later //! //! ## Features //! //! * Fully support async/await. //! * Type safety. //! * Rustfmt friendly (Procedural Macro). //! * Custom scalar. //! * Minimal overhead. //! * Easy integration (hyper, actix_web, tide ...). //! //! ## License //! //! Licensed under either of //! //! * Apache License, Version 2.0, //! (./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) //! * MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT) //! at your option. //! //! ## References //! //! * [GraphQL](https://graphql.org) #[macro_use] extern crate thiserror; #[macro_use] extern crate serde_derive; mod base; mod context; mod error; mod model; mod resolver; mod scalars; mod schema; mod types; mod validation; #[doc(hidden)] pub use anyhow; #[doc(hidden)] pub use async_trait; #[doc(hidden)] pub use graphql_parser; #[doc(hidden)] pub use serde_json; pub mod http; pub use base::GQLScalar; pub use context::{Context, Variables}; pub use error::{ErrorWithPosition, PositionError, QueryError, QueryParseError}; pub use graphql_parser::query::Value; pub use scalars::ID; pub use schema::{QueryBuilder, Schema}; pub use types::GQLEmptyMutation; pub type Result<T> = anyhow::Result<T>; pub type Error = anyhow::Error; // internal types #[doc(hidden)] pub use context::ContextSelectionSet; #[doc(hidden)] pub mod registry; #[doc(hidden)] pub use base::{GQLInputObject, GQLInputValue, GQLObject, GQLOutputValue, GQLType}; #[doc(hidden)] pub use context::ContextBase; #[doc(hidden)] pub use resolver::do_resolve; #[doc(hidden)] pub use types::{GQLEnum, GQLEnumItem}; /// Define a GraphQL object /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Field name | string | Y | /// | desc | Field description | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// /// # Field argument parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Argument name | string | Y | /// | desc | Argument description | string | Y | /// | default | Argument default value | string | Y | /// /// # The field returns the value type /// /// - A scalar value, such as `i32`, `bool` /// - Borrowing of scalar values, such as `&i32`, `&bool` /// - Vec<T>, such as `Vec<i32>` /// - Slice<T>, such as `&[i32]` /// - Option<T>, such as `Option<i32>` /// - GQLObject and `&GQLObject` /// - GQLEnum /// - Result<T, E>, such as `Result<i32, E>` /// /// # Context /// /// You can define a context as an argument to a method, and the context should be the first argument to the method. /// /// ```ignore /// #[Object] /// impl MyObject { /// async fn value(&self, ctx: &Context<'_>) -> { ... } /// } /// ``` /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// struct MyObject { /// value: i32, /// } /// /// #[Object] /// impl MyObject { /// #[field(desc = "value")] /// async fn value(&self) -> i32 { /// self.value /// } /// /// #[field(desc = "reference value")] /// async fn value_ref(&self) -> &i32 { /// &self.value /// } /// /// #[field(desc = "value with error")] /// async fn value_with_error(&self) -> Result<i32> { /// Ok(self.value) /// } /// /// #[field] /// async fn value_with_arg(&self, #[arg(default = "1")] a: i32) -> i32 { /// a /// } /// } /// /// #[async_std::main] /// async fn main() { /// let schema = Schema::new(MyObject{ value: 10 }, GQLEmptyMutation); /// let res = schema.query(r#"{ /// value /// valueRef /// valueWithError /// valueWithArg1: valueWithArg /// valueWithArg2: valueWithArg(a: 99) /// }"#).execute().await.unwrap(); /// assert_eq!(res, serde_json::json!({ /// "value": 10, /// "valueRef": 10, /// "valueWithError": 10, /// "valueWithArg1": 1, /// "valueWithArg2": 99 /// })); /// } /// ``` pub use async_graphql_derive::Object; /// Define a GraphQL enum /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Enum name | string | Y | /// | desc | Enum description | string | Y | /// /// # Item parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Item name | string | Y | /// | desc | Item description | string | Y | /// | deprecation | Item deprecation reason | string | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[Enum] /// enum MyEnum { /// A, /// #[item(name = "b")] B, /// } /// /// struct MyObject { /// value1: MyEnum, /// value2: MyEnum, /// } /// /// #[Object] /// impl MyObject { /// #[field(desc = "value")] /// async fn value1(&self) -> MyEnum { /// self.value1 /// } /// /// #[field(desc = "value")] /// async fn value2(&self) -> MyEnum { /// self.value2 /// } /// } /// /// #[async_std::main] /// async fn main() { /// let schema = Schema::new(MyObject{ value1: MyEnum::A, value2: MyEnum::B }, GQLEmptyMutation); /// let res = schema.query("{ value1 value2 }").execute().await.unwrap(); /// assert_eq!(res, serde_json::json!({ "value1": "A", "value2": "b" })); /// } /// ``` pub use async_graphql_derive::Enum; /// Define a GraphQL input object /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Field name | string | Y | /// | desc | Field description | string | Y | /// | default | Field default value | string | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[InputObject] /// struct MyInputObject { /// a: i32, /// #[field(default = "10")] /// b: i32, /// } /// /// struct MyObject; /// /// #[Object] /// impl MyObject { /// #[field(desc = "value")] /// async fn value(&self, input: MyInputObject) -> i32 { /// input.a * input.b /// } /// } /// /// #[async_std::main] /// async fn main() { /// let schema = Schema::new(MyObject, GQLEmptyMutation); /// let res = schema.query(r#" /// { /// value1: value(input:{a:9, b:3}) /// value2: value(input:{a:9}) /// }"#).execute().await.unwrap(); /// assert_eq!(res, serde_json::json!({ "value1": 27, "value2": 90 })); /// } /// ``` pub use async_graphql_derive::InputObject; /// Define a GraphQL interface /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Field name | string | N | /// | type | Field type | string | N | /// | desc | Field description | string | Y | /// | context | Method with the context | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// | args | Field arguments | [Arg] | Y | /// /// # Field argument parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Argument name | string | N | /// | type | Argument type | string | N | /// | desc | Argument description | string | Y | /// | default | Argument default value | string | Y | /// /// # Define an interface /// /// Define TypeA, TypeB, TypeC... Implement the MyInterface /// /// ```ignore /// #[Interface] /// struct MyInterface(TypeA, TypeB, TypeC, ...); /// ``` /// /// # Fields /// /// The type, name, and parameters of the interface field must exactly match the type that implements the interface, /// The internal implementation is a forward of the function call. /// You can specify the field function name that implements the interface type through the 'method' property, /// or you can specify that the field function has a context parameter through the 'context' attribute. /// /// ```rust /// use async_graphql::*; /// /// struct TypeA { /// value: i32, /// } /// /// #[Object] /// impl TypeA { /// /// Returns data borrowed from the context /// #[field] /// async fn value_a<'a>(&self, ctx: &'a Context<'_>) -> &'a str { /// ctx.data::<String>().as_str() /// } /// /// /// Returns data borrowed self /// #[field] /// async fn value_b(&self) -> &i32 { /// &self.value /// } /// /// /// With parameters /// #[field] /// async fn value_c(&self, a: i32, b: i32) -> i32 { /// a + b /// } /// } /// /// #[Interface( /// field(name = "value_a", type = "&'ctx str", context), /// field(name = "value_b", type = "&i32"), /// field(name = "value_c", type = "i32", /// arg(name = "a", type = "i32"), /// arg(name = "b", type = "i32")), /// )] /// struct MyInterface(TypeA); /// /// struct QueryRoot; /// /// #[Object] /// impl QueryRoot { /// #[field] /// async fn type_a(&self) -> MyInterface { /// TypeA { value: 10 }.into() /// } /// } /// /// #[async_std::main] /// async fn main() { /// let schema = Schema::new(QueryRoot, GQLEmptyMutation).data("hello".to_string()); /// let res = schema.query(r#" /// { /// typeA { /// valueA /// valueB /// valueC(a: 3, b: 2) /// } /// }"#).execute().await.unwrap(); /// assert_eq!(res, serde_json::json!({ /// "typeA": { /// "valueA": "hello", /// "valueB": 10, /// "valueC": 5 /// } /// })); /// } /// ``` pub use async_graphql_derive::Interface; /// Define a GraphQL union /// /// It's similar to Interface, but it doesn't have fields. pub use async_graphql_derive::Union;