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
/*! # GraphQL [GraphQL][graphql] is a data query language developed by Facebook intended to serve mobile and web application frontends. *Juniper* makes it possible to write GraphQL servers in Rust that are type-safe and blazingly fast. We also try to make declaring and resolving GraphQL schemas as convenient as possible as Rust will allow. Juniper does not include a web server - instead it provides building blocks to make integration with existing servers straightforward. It optionally provides a pre-built integration for the [Iron][iron] and [Rocket] frameworks, including embedded [Graphiql][graphiql] for easy debugging. * [Cargo crate](https://crates.io/crates/juniper) * [API Reference][docsrs] * [Book][book]: Guides and Examples ## Getting Started The best place to get started is the [Juniper Book][book], which contains guides with plenty of examples, covering all features of Juniper. To get started quickly and get a feel for Juniper, check out the [Quickstart][book_quickstart] section. For specific information about macros, types and the Juniper api, the [API Reference][docsrs] is the best place to look. You can also check out [src/tests/schema.rs][test_schema_rs] to see a complex schema including polymorphism with traits and interfaces. For an example of web framework integration, see the [rocket][rocket_examples] and [iron][iron_examples] examples folders. ## Features Juniper supports the full GraphQL query language according to the [specification][graphql_spec], including interfaces, unions, schema introspection, and validations. It does not, however, support the schema language. As an exception to other GraphQL libraries for other languages, Juniper builds non-null types by default. A field of type `Vec<Episode>` will be converted into `[Episode!]!`. The corresponding Rust type for e.g. `[Episode]` would be `Option<Vec<Option<Episode>>>`. ## Integrations ### Data types Juniper has automatic integration with some very common Rust crates to make building schemas a breeze. The types from these crates will be usable in your Schemas automatically. * [uuid][uuid] * [url][url] * [chrono][chrono] ### Web Frameworks * [rocket][rocket] * [iron][iron] ## API Stability Juniper has not reached 1.0 yet, thus some API instability should be expected. [graphql]: http://graphql.org [graphiql]: https://github.com/graphql/graphiql [iron]: http://ironframework.io [graphql_spec]: http://facebook.github.io/graphql [test_schema_rs]: https://github.com/graphql-rust/juniper/blob/master/juniper/src/tests/schema.rs [tokio]: https://github.com/tokio-rs/tokio [rocket_examples]: https://github.com/graphql-rust/juniper/tree/master/juniper_rocket/examples [iron_examples]: https://github.com/graphql-rust/juniper/tree/master/juniper_iron/examples [Rocket]: https://rocket.rs [book]: https://graphql-rust.github.io/ [book_quickstart]: https://graphql-rust.github.io/quickstart.html [docsrs]: https://docs.rs/juniper [uuid]: https://crates.io/crates/uuid [url]: https://crates.io/crates/url [chrono]: https://crates.io/crates/chrono */ #![warn(missing_docs)] extern crate serde; #[macro_use] extern crate serde_derive; #[cfg(any(test, feature = "expose-test-schema"))] extern crate serde_json; extern crate fnv; extern crate ordermap; #[cfg(any(test, feature = "chrono"))] extern crate chrono; #[cfg(any(test, feature = "url"))] extern crate url; #[cfg(any(test, feature = "uuid"))] extern crate uuid; // Depend on juniper_codegen and re-export everything in it. // This allows users to just depend on juniper and get the derive functionality automatically. #[allow(unused_imports)] #[macro_use] extern crate juniper_codegen; #[doc(hidden)] pub use juniper_codegen::*; #[macro_use] mod value; #[macro_use] mod macros; mod ast; pub mod parser; mod types; mod schema; mod validation; mod util; mod executor; // This needs to be public until docs have support for private modules: // https://github.com/rust-lang/cargo/issues/1520 pub mod integrations; pub mod graphiql; pub mod http; #[cfg(all(test, not(feature = "expose-test-schema")))] mod tests; #[cfg(feature = "expose-test-schema")] pub mod tests; #[cfg(test)] mod executor_tests; // Needs to be public because macros use it. pub use util::to_camel_case; use parser::{parse_document_source, ParseError, Spanning}; use validation::{validate_input_values, visit_all_rules, ValidatorContext}; use executor::execute_validated_query; pub use ast::{FromInputValue, InputValue, Selection, ToInputValue, Type}; pub use value::Value; pub use types::base::{Arguments, GraphQLType, TypeKind}; pub use executor::{Context, ExecutionError, ExecutionResult, Executor, FieldError, FieldResult, FromContext, IntoResolvable, Registry, Variables}; pub use validation::RuleError; pub use types::scalars::{EmptyMutation, ID}; pub use schema::model::RootNode; pub use schema::meta; /// An error that prevented query execution #[derive(Debug, PartialEq)] #[allow(missing_docs)] pub enum GraphQLError<'a> { ParseError(Spanning<ParseError<'a>>), ValidationError(Vec<RuleError>), NoOperationProvided, MultipleOperationsProvided, UnknownOperationName, } /// Execute a query in a provided schema pub fn execute<'a, CtxT, QueryT, MutationT>( document_source: &'a str, operation_name: Option<&str>, root_node: &RootNode<QueryT, MutationT>, variables: &Variables, context: &CtxT, ) -> Result<(Value, Vec<ExecutionError>), GraphQLError<'a>> where QueryT: GraphQLType<Context = CtxT>, MutationT: GraphQLType<Context = CtxT>, { let document = try!(parse_document_source(document_source)); { let errors = validate_input_values(variables, &document, &root_node.schema); if !errors.is_empty() { return Err(GraphQLError::ValidationError(errors)); } } { let mut ctx = ValidatorContext::new(&root_node.schema, &document); visit_all_rules(&mut ctx, &document); let errors = ctx.into_errors(); if !errors.is_empty() { return Err(GraphQLError::ValidationError(errors)); } } execute_validated_query(document, operation_name, root_node, variables, context) } impl<'a> From<Spanning<ParseError<'a>>> for GraphQLError<'a> { fn from(f: Spanning<ParseError<'a>>) -> GraphQLError<'a> { GraphQLError::ParseError(f) } }