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_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
import strawberry_django
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.33.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b5a936cd115170107672c1cbc00c208cade0f515d553c6ad5092c0f69b2cdea |
|
MD5 | 66a9e3922caa6bfc1b540c47c1b17432 |
|
BLAKE2b-256 | 9d373a0081566ff1a97519515d7103322cdb14a2bc2092ef707062d84545aa89 |
Close
Hashes for strawberry_graphql_django-0.33.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cfc24582f249442b3f73bf52beaa4ddb2fe3e58785b01039817091a01ba262f |
|
MD5 | a1d24fc25d8aa5348d1a29affd4f2488 |
|
BLAKE2b-256 | a8772ae11b0106e0f6ffb757b2ee135d3d1477b4cf66ff9bf7417be6a401d0ca |