graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2025-02-02 04:34:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #54 from adamcharnock/docs-adam

Browse Source 
Expanding on the django quickstart to make it a little more verbose
This commit is contained in:
Syrus Akbary 2015-11-27 14:01:13 -08:00
commit abc4c9152f
1 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/pages/docs/quickstart-django.md
View File

@ -7,7 +7,7 @@ description: A Quick guide to Graphene in Django
In our previous quickstart page we created a very simple schema.
Now we will adapt the schema to map automatically some Django models,
Now we will adapt the schema to automatically map some Django models,
and expose this schema in a `/graphql` API endpoint.
## Project setup
@ -50,7 +50,16 @@ Once you've set up a database and initial user created and ready to go, open up
## Schema
Right, we'd better write some types then. Open `tutorial/quickstart/schema.py` and get typing.
GraphQL presents your objects to the world as a graph structure rather than a more
heiricarcal structure to which you may be acustomed. In order to create this
representation, Graphene needs to know about each *type* of object which will appear in
the graph. Below we define these as the `UserType` and `GroupType` classes.
This graph also has a 'root' through which all access begins. This is the `Query` class below.
In this example, we provide the ability to list all users via `all_users`, and the
ability to obtain a single user via `get_user`.
Open `tutorial/quickstart/schema.py` and type the following:
```python
import graphene
@ -58,8 +67,8 @@ from graphene.contrib.django import DjangoObjectType
from django.contrib.auth.models import User, Group
# Graphene will map automatically the User model to UserType with
# the specified fields
# Graphene will automatically map the User model's fields onto the UserType.
# This is configured in the UserType's Meta class
class UserType(DjangoObjectType):
class Meta:
model = User
@ -68,13 +77,13 @@ class UserType(DjangoObjectType):
class GroupType(DjangoObjectType):
class Meta:
model = User
model = Group
only_fields = ('name', )
class Query(graphene.ObjectType):
all_users = graphene.List(UserType)
get_user = graphene.Field(UserType
get_user = graphene.Field(UserType,
id=graphene.String(required=True))
def resolve_all_users(self, args, info):
@ -89,8 +98,12 @@ schema = graphene.Schema(query=Query)
## Creating GraphQL and GraphiQL views
Okay, now let's wire up the GraphQL and GraphiQL urls. On to `tutorial/urls.py`...
Unlike a RESTful API, there is only a single URL from which a GraphQL is accessed.
Requests to this URL are handled by Graphene's `GraphQLView` view.
Additionally, and interface for navigating this API will be very useful. Graphene
includes the [graphiql](https://github.com/graphql/graphiql) in-browser IDE
which assits and exploring and querying your new API. We'll add a URL for this too.
```python
from django.conf.urls import url, include
@ -99,7 +112,7 @@ from graphene.contrib.django.views import GraphQLView
from tutorial.quickstart.schema import schema
# Wire up our GraphQL schema in /graphql.
# Wire up our GraphQL schema to /graphql.
# Additionally, we include GraphiQL view for querying easily our schema.
urlpatterns = [
url(r'^graphql', csrf_exempt(GraphQLView.as_view(schema=schema))),