Chalice-GraphQL
Adds GraphQL support to your Chalice application.
Based on [flask-graphql] by Syrus Akbary and [aiohttp-graphql] by Devin Fee.
Usage
Add the GraphQLView
from chalice_graphql
to dispatch requests for your desired route(s)
from chalice import Chalice
from chalice_graphql import GraphQLView
from schema import schema
app = Chalice(app_name='helloworld')
@app.route(
'/graphql',
methods=['GET', 'POST'],
content_types=['application/graphql', 'application/json', 'application/x-www-form-urlencoded']
)
def graphql():
gql_view = GraphQLView(schema=schema, graphiql=True)
return gql_view.dispatch_request(app.current_request)
# Optional, for adding batch query support (used in Apollo-Client)
@app.route(
'/graphql/batch',
methods=['GET', 'POST'],
content_types=['application/graphql', 'application/json', 'application/x-www-form-urlencoded']
)
def graphql_batch():
gql_view = GraphQLView(schema=schema, batch=True)
return gql_view.dispatch_request(app.current_request)
This will add /graphql
endpoint to your app and enable the GraphiQL IDE.
Supported options for GraphQLView
-
schema
: TheGraphQLSchema
object that you want the view to execute when it gets a valid request. -
context
: A value to pass as thecontext_value
to graphqlexecute
function. By default is set todict
with request object at keyrequest
. -
root_value
: Theroot_value
you want to provide to graphqlexecute
. -
pretty
: Whether or not you want the response to be pretty printed JSON. -
graphiql
: IfTrue
, may present GraphiQL when loaded directly from a browser (a useful tool for debugging and exploration). -
graphiql_version
: The graphiql version to load. Defaults to "1.0.3". -
graphiql_template
: Inject a Jinja template string to customize GraphiQL. -
graphiql_html_title
: The graphiql title to display. Defaults to "GraphiQL". -
batch
: Set the GraphQL view as batch (for using in Apollo-Client or ReactRelayNetworkLayer) -
middleware
: A list of graphql middlewares. -
encode
: the encoder to use for responses (sensibly defaults tographql_server.json_encode
). -
format_error
: the error formatter to use for responses (sensibly defaults tographql_server.default_format_error
. -
subscriptions
: The GraphiQL socket endpoint for using subscriptions in graphql-ws. -
headers
: An optional GraphQL string to use as the initial displayed request headers, if not provided, the stored headers will be used. -
default_query
: An optional GraphQL string to use when no query is provided and no stored query exists from a previous session. If not provided, GraphiQL will use its own default query. -
header_editor_enabled
: An optional boolean which enables the header editor when true. Defaults to false. -
should_persist_headers
: An optional boolean which enables to persist headers to storage when true. Defaults to false.