A Django integration for Graphene.
Visit the documentation to get started!
For installing graphene, just run this command in your shell
pip install "graphene-django>=2.0"INSTALLED_APPS = ( # ... 'django.contrib.staticfiles', # Required for GraphiQL 'graphene_django', ) GRAPHENE = { 'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives }We need to set up a GraphQL endpoint in our Django app, so we can serve the queries.
from django.urls import path from graphene_django.views import GraphQLView urlpatterns = [ # ... path('graphql', GraphQLView.as_view(graphiql=True)), ]Here is a simple Django model:
from django.db import models class UserModel(models.Model): name = models.CharField(max_length=100) last_name = models.CharField(max_length=100)To create a GraphQL schema for it you simply have to write the following:
from graphene_django import DjangoObjectType import graphene class User(DjangoObjectType): class Meta: model = UserModel class Query(graphene.ObjectType): users = graphene.List(User) def resolve_users(self, info): return UserModel.objects.all() schema = graphene.Schema(query=Query)Then you can query the schema:
query = ''' query { users { name, lastName } } ''' result = schema.execute(query)To learn more check out the following examples:
- Schema with Filtering: Cookbook example
- Relay Schema: Starwars Relay example
See CONTRIBUTING.md