graphene-django project does not currently support GraphQL subscriptions out of the box. However, there are several community-driven modules for adding subscription support, and the provided GraphiQL interface supports running subscription operations over a websocket.
To implement websocket-based support for GraphQL subscriptions, you’ll need to do the following:
- Install and configure django-channels.
- Install and configure* a third-party module for adding subscription support over websockets. A few options include:
- Ensure that your application (or at least your GraphQL endpoint) is being served via an ASGI protocol server like daphne (built in to
django-channels), uvicorn, or hypercorn.
Once your application is properly configured to handle subscriptions, you can use the GraphiQL interface to test subscriptions like any other operation.