README.md

Flask-GraphQL

Adds GraphQL support to your Flask application.

Usage

Just use the GraphQLView view from flask_graphql

from flask_graphql import GraphQLView

app.add_url_rule('/graphql', view_func=GraphQLView.as_view('graphql', schema=schema, graphiql=True))

# Optional, for adding batch query support (used in Apollo-Client)
app.add_url_rule('/graphql/batch', view_func=GraphQLView.as_view('graphql', schema=schema, batch=True))

This will add /graphql and /graphiql endpoints to your app.

Supported options

• schema: The GraphQLSchema object that you want the view to execute when it gets a valid request.
• context: A value to pass as the context to the graphql() function.
• root_value: The root_value you want to provide to executor.execute.
• pretty: Whether or not you want the response to be pretty printed JSON.
• executor: The Executor that you want to use to execute queries.
• graphiql: If True, may present GraphiQL when loaded directly from a browser (a useful tool for debugging and exploration).
• graphiql_template: Inject a Jinja template string to customize GraphiQL.
• batch: Set the GraphQL view as batch (for using in Apollo-Client or ReactRelayNetworkLayer)
• middleware: A list of graphql middlewares.

You can also subclass GraphQLView and overwrite get_root_value(self, request) to have a dynamic root value per request.

class UserRootValue(GraphQLView):
    def get_root_value(self, request):
        return request.user