Django

Strawberry comes with a basic Django integration . It provides a view that you can use to serve your GraphQL schema:

from django.urls import path
from django.views.decorators.csrf import csrf_exempt

from strawberry.django.views import GraphQLView

from api.schema import schema

urlpatterns = [
    path("graphql/", csrf_exempt(GraphQLView.as_view(schema=schema))),
]

Strawberry only provides a GraphQL view for Django, Strawberry GraphQL Django provides integration with the models. import strawberry_django should do the same as import strawberry.django if both libraries are installed.

You’d also need to add strawberry_django to the INSTALLED_APPS of your project, this is needed to provide the template for the GraphiQL interface.

Options

The GraphQLView accepts the following arguments:

schema : mandatory, the schema created by strawberry.Schema .
graphql_ide : optional, defaults to "graphiql" , allows to choose the GraphQL IDE interface (one of graphiql , apollo-sandbox or pathfinder ) or to disable it by passing None .
allow_queries_via_get : optional, defaults to True , whether to enable queries via GET requests
multipart_uploads_enabled : optional, defaults to False , controls whether to enable multipart uploads. Please make sure to consider the security implications mentioned in the GraphQL Multipart Request Specification when enabling this feature.

Deprecated options

The following options are deprecated and will be removed in a future release:

json_encoder : optional JSON encoder, defaults to DjangoJSONEncoder , will be used to serialize the data.
json_dumps_params : optional dictionary of keyword arguments to pass to the json.dumps call used to generate the response. To get the most compact JSON representation, you should specify {"separators": (",", ":")} , defaults to None .

You can extend the view and override encode_json to customize the JSON encoding process.

Extending the view

We allow to extend the base GraphQLView , by overriding the following methods:

get_context(self, request: HttpRequest, response: HttpResponse) -> Any
get_root_value(self, request: HttpRequest) -> Any
process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse

get_context

get_context allows to provide a custom context object that can be used in your resolver. You can return anything here, by default we return a StrawberryDjangoContext object.

@strawberry.type
class Query:
    @strawberry.field
    def user(self, info: strawberry.Info) -> str:
        return str(info.context.request.user)

or in case of a custom context:

class MyGraphQLView(GraphQLView):
    def get_context(self, request: HttpRequest, response: HttpResponse) -> Any:
        return {"example": 1}


@strawberry.type
class Query:
    @strawberry.field
    def example(self, info: strawberry.Info) -> str:
        return str(info.context["example"])

Here we are returning a custom context dictionary that contains only one item called “example”.

Then we use the context in a resolver, the resolver will return “1” in this case.

get_root_value

get_root_value allows to provide a custom root value for your schema, this is probably not used a lot but it might be useful in certain situations.

Here’s an example:

class MyGraphQLView(GraphQLView):
    def get_root_value(self, request: HttpRequest) -> Any:
        return Query(name="Patrick")


@strawberry.type
class Query:
    name: str

Here we are returning a Query where the name is “Patrick”, so we when requesting the field name we’ll return “Patrick” in this case.

process_result

process_result allows to customize and/or process results before they are sent to the clients. This can be useful logging errors or hiding them (for example to hide internal exceptions).

It needs to return an object of GraphQLHTTPResponse and accepts the request and the execution results.

from strawberry.http import GraphQLHTTPResponse
from strawberry.types import ExecutionResult


class MyGraphQLView(GraphQLView):
    def process_result(
        self, request: HttpRequest, result: ExecutionResult
    ) -> GraphQLHTTPResponse:
        data: GraphQLHTTPResponse = {"data": result.data}

        if result.errors:
            data["errors"] = [err.formatted for err in result.errors]

        return data

In this case we are doing the default processing of the result, but it can be tweaked based on your needs.

Async Django

Strawberry also provides an async view that you can use with Django 3.1+

from django.urls import path

from strawberry.django.views import AsyncGraphQLView

from api.schema import schema

urlpatterns = [
    path("graphql/", AsyncGraphQLView.as_view(schema=schema)),
]

You’d also need to add strawberry_django to the INSTALLED_APPS of your project, this is needed to provide the template for the GraphiQL interface.

Options

The AsyncGraphQLView accepts the following arguments:

schema : mandatory, the schema created by strawberry.Schema .
graphql_ide : optional, defaults to "graphiql" , allows to choose the GraphQL IDE interface (one of graphiql , apollo-sandbox or pathfinder ) or to disable it by passing None .
allow_queries_via_get : optional, defaults to True , whether to enable queries via GET requests

Extending the view

We allow to extend the base AsyncGraphQLView , by overriding the following methods:

async get_context(self, request: HttpRequest) -> Any
async get_root_value(self, request: HttpRequest) -> Any
async process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse
def encode_json(self, data: GraphQLHTTPResponse) -> str

get_context

get_context allows to provide a custom context object that can be used in your resolver. You can return anything here, by default we return a dictionary with the request.

class MyGraphQLView(AsyncGraphQLView):
    async def get_context(self, request: HttpRequest, response: HttpResponse) -> Any:
        return {"example": 1}


@strawberry.type
class Query:
    @strawberry.field
    def example(self, info: strawberry.Info) -> str:
        return str(info.context["example"])