graphene/docs/quickstart.rst

58 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Getting started
===============
What is GraphQL?
----------------
For an introduction to GraphQL and an overview of its concepts, please refer
to `the official introduction <http://graphql.org/learn/>`.
Lets 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"
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
one field: ``hello``. And when we query it, it should return ``"World"``.
.. 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
--------
Then we can start querying our schema:
.. code:: python
result = schema.execute('{ hello }')
print result.data['hello'] # "World"
Congrats! You got your first graphene schema working!