View Source BridgeEx.Graphql.Client (bridge_ex v2.4.1)

Graphql client for BridgeEx.

Summary

Types

bridge_response()

Functions

call(url, query, variables, opts)

Calls a GraphQL endpoint

Types

bridge_response()

@type bridge_response() ::
  {:ok, term()}
  | {:error, {:bad_response, integer()}}
  | {:error, {:http_error, String.t()}}
  | {:error, list()}

Functions

call(url, query, variables, opts)

@spec call(
  url :: String.t(),
  query :: String.t(),
  variables :: map(),
  opts :: Keyword.t()
) :: bridge_response()

Calls a GraphQL endpoint

Parameters

  • url: URL of the endpoint.
  • query: Graphql query or mutation.
  • variables: variables for Graphql query or mutation.
  • opts: various options.

Options

  • options: extra HTTP options to be passed to Telepoison.
  • headers: extra HTTP headers.
  • encode_variables: whether to JSON encode variables or not.
  • decode_keys: how JSON keys in GraphQL responses are decoded. Can be set to :strings (recommended), :atoms (discouraged due to security concerns - currently the default, but will be changed to :strings in a future version) or :existing_atoms (safer, but may crash the application if an unexpected key is received)
  • retry_options: configures retry attempts. Takes the form of [max_retries: 1, timing: :exponential]
  • log_options: configures logging on errors. Takes the form of [log_query_on_error: false, log_response_on_error: false].