ASGI
Strawberry comes with a basic ASGI integration. It provides an app that you can use to serve your GraphQL schema. Before using Strawberry’s ASGI support make sure you install all the required dependencies by running:
Once that's done you can use Strawberry with ASGI like so:
Every ASGI server will accept this app
instance to start the server. For
example if you’re using uvicorn you run the
app with uvicorn server:app
Options
The GraphQL
app accepts the following options at the moment:
-
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.
Extending the view
We allow to extend the base GraphQL
app, by overriding the following methods:
-
async get_context(self, request: Union[Request, WebSocket], response: Optional[Response] = None) -> Any
-
async get_root_value(self, request: Request) -> Any
-
async process_result(self, request: Request, result: ExecutionResult) -> GraphQLHTTPResponse
-
def encode_json(self, response_data: GraphQLHTTPResponse) -> str
-
async def render_graphql_ide(self, request: Request) -> Response
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 and the response.
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.
Setting response headers
It is possible to use get_context
to set response headers. A common use case
might be cookie-based user authentication, where your login mutation resolver
needs to set a cookie on the response.
This is possible by updating the response object contained inside the context of
the Info
object.
Setting background tasks
Similarly, background tasks can be set on the response via the context:
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.