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!]!
}
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
File details
Details for the file strawberry_graphql_django-0.24.0.tar.gz.
File metadata
- Download URL: strawberry_graphql_django-0.24.0.tar.gz
- Upload date:
- Size: 62.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.0 CPython/3.12.0 Darwin/23.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 24dc1541f1cb88b37ec5f83a2ce2a51956716e8ccc74e719b12bd49983789a23 |
|
| MD5 | 9e0d59d1c17bc2ca428af5c3540f0c77 |
|
| BLAKE2b-256 | 3edbc9d6fc954c524f2a5aa743b704c185be9155ecd3ceb74896a119c74cd26c |
File details
Details for the file strawberry_graphql_django-0.24.0-py3-none-any.whl.
File metadata
- Download URL: strawberry_graphql_django-0.24.0-py3-none-any.whl
- Upload date:
- Size: 75.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.0 CPython/3.12.0 Darwin/23.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7296ac4fa74844687b3e45c859c91f9aa188f70127fbf9f2629447db27944817 |
|
| MD5 | 9cab3023435650f0f602daa4c80958c0 |
|
| BLAKE2b-256 | 3124f6d718ed049a54ac75b385bc09a13c94c99bcd8671bc9c1c4309709ed169 |
