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.20.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bc5bf04caa66847a2cad9aed336808d98ebc9e4f5b2ece26c9417e87be372c7 |
|
MD5 | 2ffd42967b875958af17348e42522d6f |
|
BLAKE2b-256 | bf054a4fd5711d2e8a380441bc050f51572f3ca52ad6da7912a7946893dcad5b |
Close
Hashes for strawberry_graphql_django-0.20.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c4555a54bb5385c5bcdcd5a097d635cf5ce3ffdb4f4ce00a58ea38f4eedc010 |
|
MD5 | e5289d95d626882f257bba2f03878f8e |
|
BLAKE2b-256 | a9afed620c178ac932ba816ba5aab1af786dac0f29d4b577d49e5a8659aa9f51 |