Integrating Tartiflette GraphQL Engine with Django

Are you a Django developer looking to supercharge your API development with GraphQL? Look no further than tartiflette-django! In this article, we’ll explore how to seamlessly integrate Tartiflette GraphQL Engine with the popular Django framework using the tartiflette-django package.

But first, what is Tartiflette?

Tartiflette is a powerful GraphQL engine written in Python. It provides efficient and scalable execution of GraphQL queries and mutations. With Tartiflette, you can build robust and flexible APIs that meet the specific needs of your application.

Now, let’s dive into the installation and requirements for tartiflette-django.

Installation

To get started with tartiflette-django, ensure that you have the Tartiflette dependencies installed. You can find detailed instructions in the Tartiflette tutorial.

Once you have the dependencies set up, you can easily install tartiflette-django from PyPI using pip:

#bash
pip install tartiflette-django

Requirements

tartiflette-django is compatible with:

• Python 3.6+.
• Django 3.0+.
• Tartiflette 1.x.

Ensure that you meet these requirements before proceeding with the integration.

Quickstart

To integrate Tartiflette GraphQL Engine with Django, follow these steps:

1. Add a GraphQL schema to your Django application: Create a schema.graphql file in your Django project directory and define your GraphQL types and queries. Here’s an example schema:

#graphql
type User {
  id: ID!
  firstName: String!
  lastName: String!
  email: String!
}

type Query {
  currentUser: User
}

schema { query: Query }

2. Configure Tartiflette in your Django settings: Open your settings.py file and set the TARTIFLETTE_SDL variable to the path of your GraphQL schema file.

#python
TARTIFLETTE_SDL = BASE_DIR / "" / "schema.graphql"

3. Create a URL for the GraphQL endpoint: In your urls.py file, import the GraphQLView from tartiflette_django.views, and add a path for the GraphQL endpoint.

#python
from django.urls import path
from tartiflette_django.views import GraphQLView

urlpatterns = [
    path('graphql/', GraphQLView.as_view()),
    # ...
]

4. Write your resolvers: Create a file, such as resolvers.py, inside your Django app directory and define your resolvers. Here’s an example resolver for the Query.currentUser field:

#python
from tartiflette import Resolver

@Resolver("Query.currentUser")
async def resolve_current_user(parent, args, context, info):
    user = context["request"].user
    if not user.is_authenticated:
        return None

    return user

And that’s it! You’ve successfully integrated Tartiflette GraphQL Engine with Django using tartiflette-django. Now you can start building powerful and flexible APIs with ease.

In conclusion, tartiflette-django is a fantastic tool for Django developers who want to leverage the power of GraphQL in their applications. It provides seamless integration with the Django framework and allows you to take advantage of Tartiflette’s performance and scalability.

If you have any questions or need further assistance, feel free to reach out and ask. Happy coding!

References

• Tartiflette API documentation
• “tartiflette-django” repository by mixkorshun