2016-09-12 07:47:34 +03:00
|
|
|
|
Getting started
|
|
|
|
|
===============
|
|
|
|
|
|
2016-11-05 17:31:56 +03:00
|
|
|
|
What is GraphQL?
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
For an introduction to GraphQL and an overview of its concepts, please refer
|
|
|
|
|
to `the official introduction <http://graphql.org/learn/>`.
|
|
|
|
|
|
2016-09-12 07:47:34 +03:00
|
|
|
|
Let’s build a basic GraphQL schema from scratch.
|
|
|
|
|
|
|
|
|
|
Requirements
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
- Python (2.7, 3.2, 3.3, 3.4, 3.5, pypy)
|
|
|
|
|
- Graphene (1.0)
|
|
|
|
|
|
|
|
|
|
Project setup
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
.. code:: bash
|
|
|
|
|
|
2016-09-26 19:16:27 +03:00
|
|
|
|
pip install "graphene>=1.0"
|
2016-09-12 07:47:34 +03:00
|
|
|
|
|
|
|
|
|
Creating a basic Schema
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
A GraphQL schema describes your data model, and provides a GraphQL
|
|
|
|
|
server with an associated set of resolve methods that know how to fetch
|
|
|
|
|
data.
|
|
|
|
|
|
|
|
|
|
We are going to create a very simple schema, with a ``Query`` with only
|
2016-10-07 11:56:01 +03:00
|
|
|
|
one field: ``hello``. And when we query it, it should return ``"World"``.
|
2016-09-12 07:47:34 +03:00
|
|
|
|
|
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
import graphene
|
|
|
|
|
|
|
|
|
|
class Query(graphene.ObjectType):
|
|
|
|
|
hello = graphene.String()
|
|
|
|
|
|
|
|
|
|
def resolve_hello(self, args, context, info):
|
|
|
|
|
return 'World'
|
|
|
|
|
|
|
|
|
|
schema = graphene.Schema(query=Query)
|
|
|
|
|
|
|
|
|
|
Querying
|
|
|
|
|
--------
|
|
|
|
|
|
2016-10-07 11:56:01 +03:00
|
|
|
|
Then we can start querying our schema:
|
2016-09-12 07:47:34 +03:00
|
|
|
|
|
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
result = schema.execute('{ hello }')
|
|
|
|
|
print result.data['hello'] # "World"
|
|
|
|
|
|
|
|
|
|
Congrats! You got your first graphene schema working!
|