Compile-time GraphQL client for Elixir.

Validates GraphQL operations at compile time and generates typed Ecto embedded schemas for responses.

Usage

defmodule MyApp.GitHub do
  use TypedGql,
    otp_app: :my_app,
    source: "priv/schemas/github.json"

  defgql :get_user, ~GQL"""
    query($login: String!) {
      user(login: $login) {
        name
      }
    }
  """
end

Options

• :otp_app (required) — the OTP application for runtime config lookup

• :source (required) — path to a schema JSON file (relative to the caller file), or an inline JSON string

• :scalars — custom scalar type mappings (default: %{})

• :generation_plugins — TypedGql.Generation.Plugin modules that hook into response-type generation. TypedGql's built-in plugins (e.g. @include/@skip handling) always run first; these are appended after them (default: [])

• :endpoint — default GraphQL endpoint URL. Optional: the URL can also come from :req_options (:url/:base_url) or from prepare_req/1

• :req_options — default Req options passed directly to Req.new/1 (keyword list). Supports all Req options including middleware/plugins. Common examples:

  • Headers: req_options: [headers: [authorization: "Bearer token"]]
  • Timeouts: req_options: [receive_timeout: 30_000]
  • Plug (for testing): req_options: [plug: {Req.Test, MyApp.GitHub}]

  You can also attach Req plugins via the :req_options key. Plugins are attached by passing the plugin's attach/1 options:

  # In config/runtime.exs
  config :my_app, MyApp.GitHub,
    req_options: [auth: {:bearer, System.fetch_env!("GITHUB_TOKEN")}]
  
  # In test setup
  config :my_app, MyApp.GitHub,
    req_options: [plug: {Req.Test, MyApp.GitHub}]