To start using GraphQL Modules, all you need is to install it's package and
We highly recommend to use TypeScript for writing your backend, since it provides support for Reflection (if you plan to use dependency injection) and makes it easier to develop API services.
To create a Module, use
Each module contains GraphQL Type definitions, unique id and optionally resolvers.
We are using
createModule to declare our module, and name it as
my-module. Naming is important, because it help you to locate issues in your type definition.
We also added
dirname and pointed it to
__dirname in order to make it simpler later to match exception to the correct file. It's optional, but useful.
Next, there is
resolvers which you should already know if you are familiar with GraphQL. It defines the type we have in that module, and the implementation behind it.
At this point, this module acts like a types "capsule" you can load and import to various GraphQL
As mentioned before, Modules create Application, so let's create one. We are importing the module we created earlier, and provide it to the application:
Application doesn't allow providing schemas or resolvers, since it's only a loader of your various modules.
Now that you have
Application and you got your
GraphQLSchema, you need to make it available to consumption.
GraphQL-Modules allow you to do much more, like managing the lifecycle of your execution, encapsulate your HTTP request and more. To do that in the most optimal and flexible way, we need to wrap the GraphQL execution flow. Some GraphQL servers implementation allow this kind of flexibility, and some doesn't.
But we got you covered, and provided solution for all popular GraphQL server implementations.
createSubscription methods, which are just plug-and-play replacements for the default functions from
- Apollo Server
- Express GraphQL
- Other servers?
If you are using Apollo-Server, you can use
createSchemaForApollo to get a schema that is adapted for this server, and integrates with it perfectly.
If you are using Express-GraphQL, here's how you do it:
If you are using GraphQL-Helix, here's how you do it:
If you are using a different server or setup, you can get the custom
subscribe functions from your
Application, and provide it to your server:
In case you are still having issues, you can always report an issue on a missing integration, and we'll look into that ;)
If you're interested in a step by step tutorial, one of our community members Godwin Ekuma wrote an amazing article explaining "How to modularize GraphQL schema with GraphQL Modules".