/graphql-drupal

GraphQL integration for Drupal 8

Primary LanguagePHP

GraphQL for Drupal

Build Status

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

Currently, you can expose your own custom schema through custom code with minimal effort. In the near future, we will add the ability to automatically generate a full schema from the underlying Drupal data graph.

The module is currently meant as a basis for custom development rather than pure site building. As such, it leaves it up to you as a developer to choose whether/how to expose fields and non-entity data. To help you with this task, it provides base a flexible integrations layer for you to define your own schema.

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

This module is built around https://github.com/Youshido/GraphQL. As such, it supports the full official GraphQL specification with all its features.

Examples

The module itself contains an submodule which serves as an example for how to build a custom schema.

Check out https://github.com/fubhy/drupal-decoupled-app for a complete example of a fully decoupled React and GraphQL application. Feel free to use that repository as a starting point for your own decoupled application.

Future features

Built-in generated schema

We are currently working on a complementary module for automatically exposing all content and configuration entities as a GraphQL schema making the whole Drupal entity graph available to your client application. Stay tuned.

Resources