Flask
Strawberry comes with a basic Flask integration. It provides a view that you can use to serve your GraphQL schema:
from strawberry.flask.views import GraphQLView
from api.schema import schema app = Flask(__name__)
app.add_url_rule( "/graphql", view_func=GraphQLView.as_view("graphql_view", schema=schema),)
Options
The GraphQLView
accepts two options at the moment:
- schema: mandatory, the schema created by
strawberry.Schema
. - graphiql: optional, defaults to
True
, whether to enable the GraphiQL interface.
Extending the view
We allow to extend the base GraphQLView
, by overriding the following methods:
get_context(self) -> Any
get_root_value(self) -> Any
process_result(self, 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 dictionary with
the request.
class MyGraphQLView(GraphQLView): def get_context(self) -> Any: return {"example": 1}
@strawberry.typeclass Query: @strawberry.field def 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
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) -> 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
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 execution result.
from strawberry.http import GraphQLHTTPResponsefrom strawberry.types import ExecutionResult
from graphql.error import format_error as format_graphql_error
class MyGraphQLView(GraphQLView): def process_result( self, 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.