Schemas

Juniper follows a code-first approach to defining GraphQL schemas. If you would like to use a schema-first approach instead, consider juniper-from-schema for generating code from a schema file.

A schema consists of three types: a query object, a mutation object, and a subscription object. These three define the root query fields, mutations and subscriptions of the schema, respectively.

The usage of subscriptions is a little different from the mutation and query objects, so there is a specific section that discusses them.

Both query and mutation objects are regular GraphQL objects, defined like any other object in Juniper. The mutation and subscription objects, however, are optional since schemas can be read-only and do not require subscriptions. If mutation/subscription functionality is not needed, consider using EmptyMutation/EmptySubscription.

In Juniper, the RootNode type represents a schema. When the schema is first created, Juniper will traverse the entire object graph and register all types it can find. This means that if you define a GraphQL object somewhere but never reference it, it will not be exposed in a schema.

The query root

The query root is just a GraphQL object. You define it like any other GraphQL object in Juniper, most commonly using the graphql_object proc macro:

#![allow(unused_variables)]
extern crate juniper;
use juniper::{graphql_object, FieldResult, GraphQLObject};
#[derive(GraphQLObject)] struct User { name: String }
struct Root;

#[graphql_object]
impl Root {
    fn userWithUsername(username: String) -> FieldResult<Option<User>> {
        // Look up user in database...
      unimplemented!()
    }
}

fn main() { }

Mutations

Mutations are also just GraphQL objects. Each mutation is a single field that performs some mutating side-effect such as updating a database.

#![allow(unused_variables)]
extern crate juniper;
use juniper::{graphql_object, FieldResult, GraphQLObject};
#[derive(GraphQLObject)] struct User { name: String }
struct Mutations;

#[graphql_object]
impl Mutations {
    fn signUpUser(name: String, email: String) -> FieldResult<User> {
        // Validate inputs and save user in database...
      unimplemented!()
    }
}

fn main() { }

Converting a Rust schema to the GraphQL Schema Language

Many tools in the GraphQL ecosystem require the schema to be defined in the GraphQL Schema Language. You can generate a GraphQL Schema Language representation of your schema defined in Rust using the schema-language feature (on by default):

extern crate juniper;
use juniper::{
    graphql_object, EmptyMutation, EmptySubscription, FieldResult, RootNode,
};

struct Query;

#[graphql_object]
impl Query {
    fn hello(&self) -> FieldResult<&str> {
        Ok("hello world")
    }
}

fn main() {
    // Define our schema in Rust.
    let schema = RootNode::new(
        Query,
        EmptyMutation::<()>::new(),
        EmptySubscription::<()>::new(),
    );

    // Convert the Rust schema into the GraphQL Schema Definition Language.
    let result = schema.as_sdl();

    let expected = "\
schema {
  query: Query
}

type Query {
  hello: String!
}
";
  #[cfg(not(target_os = "windows"))]
    assert_eq!(result, expected);
}

Note the schema-language feature may be turned off if you do not need this functionality to reduce dependencies and speed up compile times.