Strawberry GraphQL Django extension
Project description
Strawberry GraphQL Django integration
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
Supported Features
- 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
- Permission extension using django's permissioning system
- Relay support with automatic resolvers generation
- Query optimization to improve performance and avoid common pitfalls (e.g n+1)
- Debug Toolbar integration with graphiql to display metrics like SQL queries
- 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",
on_delete=models.CASCADE,
related_name="fruits",
blank=True,
null=True,
)
class Color(models.Model):
name = models.CharField(
max_length=20,
help_text="field description",
)
# types.py
import strawberry
import strawberry.django
from strawberry import auto
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 strawberry_django.optimizer import DjangoOptimizerExtension
from .types import Fruit
@strawberry.type
class Query:
fruits: list[Fruit] = strawberry.django.field()
schema = strawberry.Schema(
query=Query,
extensions=[
DjangoOptimizerExtension, # not required, but highly recommended
],
)
# 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)),
]
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!]!
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for strawberry_graphql_django-0.24.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c668f95bfc8622168ed6125c383c9a473cac39c318bda941a58295b1b0846961 |
|
MD5 | c7f37481e571f0cd1b77b4e5969584d3 |
|
BLAKE2b-256 | bb4470a1583983bb73dadc9f0415a22520aebdc9bd4185730fe7a593bdf406f6 |
Close
Hashes for strawberry_graphql_django-0.24.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96e49ce46f804c5a1fee10798f51a864407674de5d237ac9784b9c812a596b5e |
|
MD5 | bcc3e5f81976fd9309f84315daceaa74 |
|
BLAKE2b-256 | 965901fa14c6d92390929b53b45d0b511866abc7ade7686b1ad17c340f2bd0d7 |