Crate juniper_compose

Merge multiple Juniper object definitions into a single object type.

crates.io | docs | github

Motivation

You are building a GraphQL server using Juniper. At some point you realize that you have gigantic Query and Mutation types:

#[derive(Default)]
struct Query;

#[juniper::graphql_object]
impl Query {
    async fn user(ctx: &Context, id: Uuid) -> User {
        // ...
    }

    async fn users(ctx: &Context) -> Vec<User> {
        // ...
    }

    async fn task(ctx: &Context, id: Uuid) -> Task {
        // ...
    }

    async fn tasks(ctx: &Context) -> Vec<Task> {
        // ...
    }
     
    // ...many more
}

You would like to split it up into multiple domain-specific files, and have e.g. all User queries in one file and all Task queries in the other. With current Juniper API, it is very hard to do, but this crate can help you.

Usage

#[derive(Default)]
struct UserQueries;

#[composable_object]
#[juniper::graphql_object]
impl UserQueries {
    async fn user(ctx: &Context, id: Uuid) -> User {
        // ...
    }

    async fn users(ctx: &Context) -> Vec<User> {
        // ...
    }
}

#[derive(Default)]
struct TaskQueries;

#[composable_object]
#[juniper::graphql_object]
impl TaskQueries {
    async fn task(ctx: &Context, id: Uuid) -> Task {
        // ...
    }

    async fn tasks(ctx: &Context) -> Vec<Task> {
        // ...
    }
}

composite_object!(Query(UserQueries, TaskQueries));

Custom contexts are supported:

composite_object!(Query<Context = MyCustomContext>(UserQueries, TaskQueries));

Visibility specifier for generated type is supported:

composite_object!(pub(crate) Query<Context = MyCustomContext>(UserQueries, TaskQueries));

Custom scalars are currently not supported, but will be added if requested.

Macros

composite_object

Composes an object type from multiple ComposableObjects. Custom context type may be specified, otherwise defaults to (). Custom visibility fro generated type may be specified.

Traits

ComposableObject

Object types that you want to compose into one must implement this trait. Use composable_object to implement it.

Attribute Macros

composable_object

Implements ComposableObject for a GraphQL object type. Important: must be applied before the juniper::graphql_object macro.