Ariadne

Ariadne is a Python library for implementing GraphQL servers.

It presents a simple, easy-to-learn and extend API, with a declaratory approach to type definition that uses a standard Schema Definition Language shared between GraphQL tools, production-ready WSGI middleware, simple dev server for local experiments and an awesome GraphQL Playground for exploring your APIs.

Features

• Simple, quick to learn and easy to memorize API.
• Compatibility with GraphQL.js version 14.0.2.
• Queries, mutations and input types.
• Asynchronous resolvers and query execution.
• Subscriptions.
• Custom scalars and enums.
• Unions and interfaces.
• Defining schema using SDL strings.
• Loading schema from .graphql files.
• WSGI middleware for implementing GraphQL in existing sites.
• Opt-in automatic resolvers mapping between camelCase and snake_case.
• Build-in simple synchronous dev server for quick GraphQL experimentation and GraphQL Playground.
• Support for Apollo GraphQL extension for Visual Studio Code.
• GraphQL syntax validation via gql() helper function. Also provides colorization if Apollo GraphQL extension is installed.

Requirements and installation

Ariadne requires Python 3.6 or 3.7 and can be installed from Pypi:

pip install ariadne

Table of contents

• Introduction
  • Defining schema
  • Validating schema
  • Resolvers
  • Making executable schema
  • Testing the API
  • Completed code
• Resolvers
  • Intro
  • Binding resolvers
  • Handling arguments
  • Aliases
  • Fallback resolvers
  • Default resolver
  • Query shortcut
• Mutations
  • Defining mutations
  • Writing resolvers
  • Mutation payloads
  • Inputs
• Error messaging
  • Debugging errors
  • Replacing default error formatter
• Custom scalars
  • Example read-only scalar
  • Scalars as input
  • Configuration reference
• Enumeration types
  • Mapping to internal values
• Union types
  • Union example
  • __typename field
• Interface types
  • Interface example
  • Field resolvers
• Subscriptions
  • Defining subscriptions
  • Writing subscriptions
• Documenting a GraphQL schema
  • GraphQL Playground
  • Descriptions
  • Introspection Queries
• Modularization
  • Defining schema in .graphql files
  • Defining schema in multiple modules
  • Defining types in multiple modules
• Bindables
  • Schema validation
  • Creating custom bindable
• Local development
  • Starting a local server
• ASGI app
  • Using with an ASGI server
  • Customizing context or root
• WSGI app
  • Using with a WSGI server
  • Customizing context or root
  • Using the middleware
• Custom server example
  • Creating executable schema
  • Basic GraphQL server with Django
• Ariadne logo
  • Complete logo
  • Labyrinth only
  • Vertical logo