Getting started¶

What is GraphQL?¶

For an introduction to GraphQL and an overview of its concepts, please refer to the official introduction.

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¶

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 an input name. And when we query it, it should return "Hello {name}".

import graphene

class Query(graphene.ObjectType):
    hello = graphene.String(name=graphene.Argument(graphene.String, default_value="stranger"))

    def resolve_hello(self, args, context, info):
        return 'Hello ' + args['name']

schema = graphene.Schema(query=Query)

Querying¶

Then we can start querying our schema:

result = schema.execute('{ hello }')
print result.data['hello'] # "Hello stranger"

Congrats! You got your first graphene schema working!