Edit

Initialization of your Tartiflette recipes manager GraphQL API

We are going to create a Tartiflette recipes manager served by a GraphQL API, an exciting application which will allow you to manage efficiently all your recipes.

Here is a list of some features we are going to implement:

• list recipes (Query operation)
• update a recipe (Mutation operation)
• launch and wait for the end of the cooking process (Subscription operation)
• adding rate limiting on updating recipes (How to implement directives)
• do not expose all your GraphQL API for everyone, limit the administration features, Mutation, to administrators

Initialization of the recipes manager project

Prepare your favorite editor and your terminal, we will switch back and forth between them.

First, create the project's directory called ttftt-recipes-manager:

mkdir ttftt-recipes-manager/

# Move to the directory we just created
cd ttftt-recipes-manager

We will put all our python files into the recipes_manager Python module:

mkdir -p recipes_manager

Moreover, we are going to create multiple files which will contain our application code:

• recipes_manager/app.py: entrypoint of our application. In charge of the initialization of the tartiflette-aiohttp server
• recipes_manager/sdl: directory which will contain our SDL (Schema Definition Language) files
  • recipes_manager/sdl/Query.graphql: schema with our Query type
  • recipes_manager/sdl/Mutation.graphql: schema with our Mutation type
  • recipes_manager/sdl/Subscription.graphql: schema with our Subscription type
• recipes_manager/query_resolvers.py: will contain the Query resolvers
• recipes_manager/mutation_resolvers.py: will contain the Mutation resolvers
• recipes_manager/subscription_resolvers.py: will contain the Subscription resolvers
• recipes_manager/data.py: will contain the data used by the resolvers
• recipes_manager/directives/auth.py: will contain the logic of the @auth directive
• recipes_manager/directives/rate_limiting.py: will contain the logic of the @rateLimit directive

mkdir -p recipes_manager/sdl recipes_manager/directives

touch recipes_manager/__init__.py
touch recipes_manager/__main__.py
touch recipes_manager/directives/__init__.py

touch recipes_manager/app.py
touch recipes_manager/sdl/Query.graphql
touch recipes_manager/sdl/Mutation.graphql
touch recipes_manager/sdl/Subscription.graphql
touch recipes_manager/query_resolvers.py
touch recipes_manager/mutation_resolvers.py
touch recipes_manager/subscription_resolvers.py
touch recipes_manager/data.py
touch recipes_manager/directives/auth.py
touch recipes_manager/directives/rate_limiting.py

Your tree should look something like this:

.
└── recipes_manager
    ├── __init__.py
    ├── __main__.py
    ├── app.py
    ├── data.py
    ├── directives
    │   ├── __init__.py
    │   ├── auth.py
    │   └── rate_limiting.py
    ├── mutation_resolvers.py
    ├── query_resolvers.py
    ├── sdl
    │   ├── Mutation.graphql
    │   ├── Query.graphql
    │   └── Subscription.graphql
    └── subscription_resolvers.py

Our data

We will need some data to execute query, mutation and subscription.

Fill the file recipes_manager/data.py with this data:

# Dictionnary which contains the ingredients based on the recipe ID as key.
INGREDIENTS = {
    1: [
        {"name": "potato", "quantity": 10, "unitMeasurement": "UNIT"},
        {"name": "onion", "quantity": 2, "unitMeasurement": "UNIT"},
        {"name": "bacon", "quantity": 100, "unitMeasurement": "GRAM"},
        {"name": "white wine", "quantity": 0.05, "unitMeasurement": "LITER"},
        {"name": "reblochon AOP", "quantity": 1, "unitMeasurement": "UNIT"},
    ],
    2: [
        {"name": "potato", "quantity": 1000, "unitMeasurement": "GRAM"},
        {"name": "bacon", "quantity": 200, "unitMeasurement": "GRAM"},
        {"name": "onion", "quantity": 200, "unitMeasurement": "GRAM"},
        {"name": "reblochon AOP", "quantity": 1, "unitMeasurement": "UNIT"},
        {
            "name": "tablespoon of oil",
            "quantity": 2,
            "unitMeasurement": "UNIT",
        },
        {"name": "clove of garlic", "quantity": 1, "unitMeasurement": "UNIT"},
    ],
    3: [
        {"name": "potato", "quantity": 1000, "unitMeasurement": "GRAM"},
        {"name": "smoked bacon", "quantity": 200, "unitMeasurement": "GRAM"},
        {"name": "onion", "quantity": 2, "unitMeasurement": "UNIT"},
        {"name": "reblochon AOP", "quantity": 1, "unitMeasurement": "UNIT"},
        {"name": "fresh cream", "quantity": 0.100, "unitMeasurement": "LITER"},
        {"name": "butter", "quantity": 40, "unitMeasurement": "GRAM"},
        {
            "name": "tablespoon of pepper",
            "quantity": 1,
            "unitMeasurement": "UNIT",
        },
    ],
}

RECIPES = [
    {"id": 1, "name": "Tartiflette by Eric Guelpa", "cookingTime": 15},
    {"id": 2, "name": "La 'vraie' Tartiflette", "cookingTime": 20},
    {"id": 3, "name": "Tartiflette by Alain Ducasse", "cookingTime": 25},
]

Let's start coding :tada: