absinthe v1.1.6 API Reference
Modules
Documentation for the Absinthe package, a toolkit for building GraphQL APIs with Elixir
Absinthe supports an adapter mechanism that allows developers to define their
schema using one code convention (eg, snake_cased
fields and arguments), but
accept query documents and return results (including names in errors) in
another (eg, camelCase
)
This defines an adapter that supports GraphQL query documents in their conventional (in JS) camelcase notation, while allowing the schema to be defined using conventional (in Elixir) underscore (snakecase) notation, and tranforming the names as needed for lookups, results, and error messages
The default adapter, which makes no changes to incoming query document ASTs or outgoing results
Information passed to aid resolution functions, describing the current field’s execution environment
Introspection support
Define a GraphQL schema
This module contains macros used to build GraphQL types
Used to define an argument
Built in data types
Used by the GraphQL runtime as a way of modifying execution behavior
Used to define an enum type, a special scalar that can only have a defined set of values
A possible value for an enum
Used to define a field
Defines a GraphQL input object
A defined interface type that represent a list of named fields and their arguments
A wrapping type which declares the type of each item in the list
A type that wraps an underlying type, acting identically to that type but adding a non-null constraint
Represents a non-leaf node in a GraphQL tree of information
Represents a primitive value
A unions is an abstract type made up of multiple possible concrete types
Generate a schema.graphql file
Generate a schema.json file
Exceptions
An error during execution
Exception raised when a schema is invalid
Exception raised when a schema is invalid
An error during parsing