Getting started

Requirements

• Python 3
• A Wagtail project

If you do not have a Wagtail project set up, please follow the guide to create one.

Download

This package can be installed from the PyPI via pip.

pip install wagtail-graphql-api

This package should be installed as a dependency of an existing Wagtail project.

Configuration

The package is a Django application. It needs to be added to your Wagtail project’s setting file. Also graphene_django is a package used by wagtail-graphql-api, therefore it needs to be enabled as well.

# settings.py

INSTALLED_APPS = [
    # The rest of your apps...
    'graphene_django',
    'wagtail_graphql',
]

Next step is to set up Graphene to use the schema provided by wagtail-graphql-api.

# settings.py

GRAPHENE = {
    'SCHEMA': 'wagtail_graphql.schema.schema'
}

After that is done, the GraphQL endpoint has to be exposed in the URL dispatcher. To do that you need to add a path in the configuration, usually it is a urls.py file.

# urls.py

from django.urls import path

from graphene_django.views import GraphQLView

urlpatterns = [
    # Other URL paths...
    path('graphql/', GraphQLView.as_view(graphiql=True, pretty=True)),
    # Other URL paths...
]

Then after the development server is started (./manage.py runserver), the GraphQL endpoint should be accessible via http://localhost:8000/graphql/.