GraphQL

This module lets you craft and expose a GraphQL schema for Drupal 10 and 11.

It is is built around webonyx/graphql-php. As such, it supports the full official GraphQL specification with all its features.

You can use this module as a foundation for building your own schema with lots of data producer plugins available and through custom code.

For ease of development, it includes the GraphiQL interface at /graphql/explorer.

Example implementation

Example modules: https://git.drupalcode.org/project/graphql/-/tree/5.x/examples

Resources

Documentation: https://drupal-graphql.gitbook.io/graphql/
Project homepage: https://www.drupal.org/project/graphql

Upgrading from 4.x to 5.x

GraphQL 5.x has the same architecture as 4.x, the main differences are small PHP type API breaks. Upgrading is recommended, check the release notes.

Old 3.x version

The 3.x version of this module is now in maintenance mode.

Differences to the 5.x and 4.x versions: the 3.x version automatically generates a GraphQL schema from Drupal entities and data structures. It exposes Drupal details over the GraphQL API. The 5.x version leaves the GraphQL schema design to the developer, which makes it easier to hide Drupal internal details. The 5.x version requires the developer to setup and map the GraphQL API schema.

Check out https://github.com/drupal-graphql/drupal-decoupled-app for a complete example of a fully decoupled React and GraphQL 3.x application.

Upgrading from 3.x to 5.x

We recommend upgrading from 3.x to 5.x to take advantage of the improvements made in the GraphQL module and the underlying GraphQL library. If you still require automatic generation of the schema then take a look at the GraphQL Compose or GraphQL Core Schema projects which have implemented automatic schema generation on top of the 5.x and 4.x GraphQL module.