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
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)),
]
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.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e807492399f1c823c88d82919efb6e5a564edc405f0c72b704beec8d608b5012 |
|
MD5 | 0de1e3578bf0f1ae3aaf8aa25b8e8b0e |
|
BLAKE2b-256 | a4e62ef23e098892d9b8826fae0e52f92b70052c642182c3e932a558801a8ee9 |
Close
Hashes for strawberry_graphql_django-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eda8b06218b44ee17c348df78f155a26654699874414cd594a982cbf4760c0fe |
|
MD5 | f71d64124a716824c91eeff64d28247c |
|
BLAKE2b-256 | ffd3d9da198de0ebdda94042a18cab36c9f8ec59a98b98c614d230ea3c5d9232 |