Strawberry comes with a basic Django integration. It provides a view that you can use to serve your GraphQL schema:
from django.urls import pathfrom strawberry.django.views import GraphQLViewfrom api.schema import schemaurlpatterns = [path("graphql/", GraphQLView.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.
The GraphQLView
accepts two options at the moment:
strawberry.Schema
.True
, whether to enable the GraphiQL
interface.We allow to extend the base GraphQLView
, by overriding the following methods:
get_context(self, request: HttpRequest) -> Any
get_root_value(self, request: HttpRequest) -> Any
process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse
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(GraphQLView):def get_context(self, request: HttpRequest) -> Any:return {"example": 1}@strawberry.typeclass Query:@strawberry.fielddef example(self, info: 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
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.typeclass 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
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 GraphQLHTTPResponsefrom strawberry.types import ExecutionResultfrom graphql.error import format_error as format_graphql_errorclass MyGraphQLView(GraphQLView):def process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse:data: GraphQLHTTPResponse = {"data": result.data}if result.errors:data["errors"] = [format_graphql_error(err) 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.
Strawberry also provides an async view that you can use with Django 3.1+
from django.urls import pathfrom strawberry.django.views import AsyncGraphQLViewfrom api.schema import schemaurlpatterns = [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.
The AsyncGraphQLView
accepts two options at the moment:
strawberry.Schema
.True
, whether to enable the GraphiQL
interface.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
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) -> Any:return {"example": 1}@strawberry.typeclass Query:@strawberry.fielddef example(self, info: 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
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(AsyncGraphQLView):async def get_root_value(self, request: HttpRequest) -> Any:return Query(name="Patrick")@strawberry.typeclass 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
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 GraphQLHTTPResponsefrom strawberry.types import ExecutionResultfrom graphql.error import format_error as format_graphql_errorclass MyGraphQLView(AsyncGraphQLView):async def process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse:data: GraphQLHTTPResponse = {"data": result.data}if result.errors:data["errors"] = [format_graphql_error(err) 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.