graphene/docs/quickstart.rst

58 lines
1.3 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
------------
2017-07-24 10:01:44 +03:00
- Python (2.7, 3.4, 3.5, 3.6, pypy)
- Graphene (2.0)
Project setup
-------------
.. code:: bash
2017-07-24 10:01:44 +03:00
pip install "graphene>=2.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
2017-04-13 20:32:49 +03:00
one field: ``hello`` and an input name. And when we query it, it should return ``"Hello {name}"``.
.. code:: python
import graphene
class Query(graphene.ObjectType):
2017-07-24 10:01:44 +03:00
hello = graphene.String(name=graphene.String(default_value="stranger"))
2017-07-24 09:16:51 +03:00
def resolve_hello(self, name):
return 'Hello ' + name
schema = graphene.Schema(query=Query)
Querying
--------
Then we can start querying our schema:
.. code:: python
result = schema.execute('{ hello }')
2017-04-13 20:32:49 +03:00
print result.data['hello'] # "Hello stranger"
Congrats! You got your first graphene schema working!