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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 086f3e903cbf6296eb71f31bcf381c0ee210b0a7e5ed326d7820ea62da691959 |
|
MD5 | 2c2f99371c0d767b46fda57c3a321b83 |
|
BLAKE2b-256 | dbd56204d299af1bbe3dd49ece8c2ffd9e00daabe99a62514af2739bc7aad2b8 |
Close
Hashes for strawberry_graphql_django-0.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a065c881bb278fb1c1fe00860ffbd2ef07ce1b4c44cfb75be1a4abb5ea67f6a1 |
|
MD5 | 35ed42e9bb3224a2bb7db7c5a59617c5 |
|
BLAKE2b-256 | 1cb3add768805c3472c2b3b02c11f496588c2b039ffc36ce94b145e484a1864e |