Skip to main content

Adds GraphQL support to your WebOb (Pyramid/Pylons/...) application

Project description

Build Status Coverage Status PyPI version

Adds GraphQL support to your WebOb application.

Usage

Just use the serve_graphql_request function from webob_graphql

Pyramid

from pyramid.view import view_config

from webob_graphql import serve_graphql_request


@view_config(
    route_name='graphql',
    # The serve_graphql_request method will detect what's the best renderer
    # to use, so it will do the json render automatically.
    # In summary, don't use the renderer='json' here :)
)
def graphql_view(request):
    return serve_graphql_request(request, schema)

    # Optional, for adding batch query support (used in Apollo-Client)
    return serve_graphql_request(request, schema, batch_enabled=True)

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.

  • format_error: If you want to use a custom error formatter.

  • 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_enabled: If True (default), may present GraphiQL when loaded directly from a browser (a useful tool for debugging and exploration).

  • render_graphiql: A custom function for rendering GraphiQL (this function should have the arguments result and params).

  • batch_enabled: Enable batch support (for using in Apollo-Client or ReactRelayNetworkLayer)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

WebOb-GraphQL-1.0.dev20170404001.tar.gz (7.1 kB view details)

Uploaded Source

File details

Details for the file WebOb-GraphQL-1.0.dev20170404001.tar.gz.

File metadata

File hashes

Hashes for WebOb-GraphQL-1.0.dev20170404001.tar.gz
Algorithm Hash digest
SHA256 28401d9b88b8d92a999e96efede784e29a8783525cbe478a2fa0c9315884fd82
MD5 ba7f801efa94fdd564a4991b7eb60857
BLAKE2b-256 8093b0cf39ff70b61a572cab64e47ebc37b1687d8496f16f2f42cf2616490a81

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page