Graphene-Django
A Django integration for Graphene.
Documentation
Visit the documentation to get started!
Quickstart
For installing graphene, just run this command in your shell
pip install "graphene-django>=3"
Settings
INSTALLED_APPS = (
# ...
'django.contrib.staticfiles', # Required for GraphiQL
'graphene_django',
)
GRAPHENE = {
'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives
}
Urls
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)),
]
Examples
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
GraphQL testing clients
Contributing
See CONTRIBUTING.md
8 May 27, 2022
19 Aug 30, 2022
332 Dec 17, 2022
24.7k Jan 4, 2023
4.8k Jan 5, 2023
1.1k Dec 28, 2022
873 Dec 30, 2022
2.2k Jan 1, 2023
53 Dec 12, 2022
3.3k Jan 4, 2023
2.4k Dec 24, 2022
3k Jan 6, 2023
3.8k Dec 30, 2022
91 Dec 30, 2022
20 Jul 14, 2022
133 Jan 5, 2023
13 Sep 24, 2022
1k Dec 27, 2022
1.3k Dec 28, 2022