120 lines
3.0 KiB

# ![Graphene Logo]( Graphene-Django
A [Django]( integration for [Graphene](
[![Anaconda-Server Badge][conda-image]][conda-url]
[💬 Join the community on Slack](
## Documentation
[Visit the documentation to get started!](
## Quickstart
For installing graphene, just run this command in your shell
pip install "graphene-django>=3"
### Settings
# ...
'django.contrib.staticfiles', # Required for GraphiQL
'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 {
result = schema.execute(query)
To learn more check out the following [examples](examples/):
* **Schema with Filtering**: [Cookbook example](examples/cookbook)
* **Relay Schema**: [Starwars Relay example](examples/starwars)
## Contributing
See [](
## Release Notes
* See [Releases page on github](