Skip to content

hvdklauw/strawberry-graphql-django

 
 

Repository files navigation

Strawberry GraphQL Django integration

CI PyPI Downloads PyPI - Python Version

This package provides powerful tools to generate GraphQL types, queries, mutations and resolvers from Django models.

Installing strawberry-graphql-django package from the python package repository.

pip install strawberry-graphql-django

Full documentation is available under docs github folder.

  • GraphQL type generation from models
  • Filtering, pagination and ordering
  • Basic create, retrieve, update and delete (CRUD) types and mutations
  • Basic Django auth support, current user query, login and logout mutations
  • Django sync and async views
  • Unit test integration

Basic Usage

# models.py
from django.db import models

class Fruit(models.Model):
    """A tasty treat"""
    name = models.CharField(max_length=20)
    color = models.ForeignKey('Color', blank=True, null=True,
            related_name='fruits', on_delete=models.CASCADE)

class Color(models.Model):
    name = models.CharField(
        max_length=20,
        help_text="field description",
    )
# types.py
import strawberry
from strawberry import auto
from typing import List
from . import models

@strawberry.django.type(models.Fruit)
class Fruit:
    id: auto
    name: auto
    color: 'Color'

@strawberry.django.type(models.Color)
class Color:
    id: auto
    name: auto
    fruits: List[Fruit]
# schema.py
import strawberry
from typing import List
from .types import Fruit

@strawberry.type
class Query:
    fruits: List[Fruit] = strawberry.django.field()

schema = strawberry.Schema(query=Query)

Code above generates following schema.

"""
A tasty treat
"""
type Fruit {
  id: ID!
  name: String!
  color: Color
}

type Color {
  id: ID!
  """
  field description
  """
  name: String!
  fruits: [Fruit!]
}

type Query {
  fruits: [Fruit!]!
}
# urls.py
from django.urls import include, path
from strawberry.django.views import AsyncGraphQLView
from .schema import schema

urlpatterns = [
    path('graphql', AsyncGraphQLView.as_view(schema=schema)),
]

About

Strawberry GraphQL Django extension

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.9%
  • Other 1.1%