Django
Strawberry comes with a basic Django integration . It provides a view that you can use to serve your GraphQL 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 bystrawberry.Schema
. -
graphql_ide
: optional, defaults to"graphiql"
, allows to choose the GraphQL IDE interface (one ofgraphiql
,apollo-sandbox
orpathfinder
) or to disable it by passingNone
. -
allow_queries_via_get
: optional, defaults toTrue
, whether to enable queries viaGET
requests -
multipart_uploads_enabled
: optional, defaults toFalse
, 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 toDjangoJSONEncoder
, will be used to serialize the data. -
json_dumps_params
: optional dictionary of keyword arguments to pass to thejson.dumps
call used to generate the response. To get the most compact JSON representation, you should specify{"separators": (",", ":")}
, defaults toNone
.
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:
-
def get_context(self, request: HttpRequest, response: HttpResponse) -> Any
-
def get_root_value(self, request: HttpRequest) -> Any
-
def process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse
-
def render_graphql_ide(self, request: HttpRequest) -> HttpResponse
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.
or in case of a custom context:
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:
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.
In this case we are doing the default processing of the result, but it can be tweaked based on your needs.
render_graphql_ide
In case you need more control over the rendering of the GraphQL IDE than the
graphql_ide
option provides, you can override the render_graphql_ide
method.
Async Django
Strawberry also provides an async view that you can use with Django 3.1+
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 bystrawberry.Schema
. -
graphql_ide
: optional, defaults to"graphiql"
, allows to choose the GraphQL IDE interface (one ofgraphiql
,apollo-sandbox
orpathfinder
) or to disable it by passingNone
. -
allow_queries_via_get
: optional, defaults toTrue
, whether to enable queries viaGET
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
-
async def render_graphql_ide(self, request: HttpRequest) -> HttpResponse
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.
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:
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.
In this case we are doing the default processing of the result, but it can be tweaked based on your needs.
encode_json
encode_json
allows to customize the encoding of the JSON response. By default
we use json.dumps
but you can override this method to use a different encoder.
render_graphql_ide
In case you need more control over the rendering of the GraphQL IDE than the
graphql_ide
option provides, you can override the render_graphql_ide
method.
Subscriptions
Subscriptions run over websockets and thus depend on channels . Take a look at our channels integraton page for more information regarding it.