Absinthe GraphQL Spickzettel

Absinthe ist das vollstaendige GraphQL-Toolkit fuer Elixir- und Phoenix-Anwendungen.

Erste Schritte und Kernkonzepte (Core Concepts)

Schema: Die Wurzeldefinition fuer Abfragen, Mutationen und Typen.
Resolver: Die Elixir-Funktion zum Abrufen oder Modifizieren von Daten.
Type: Definiert die Struktur, Felder und Constraints von Datenentitaeten.

Plug-Integration in Phoenix

# web/router.ex
defmodule Blog.Web.Router do
  use Phoenix.Router

  forward "/api", Absinthe.Plug,
    schema: Blog.Schema
end

Absinthe arbeitet als Plug und akzeptiert Ihre root-Schema-Konfiguration.

Schema-Definition (Schema Definition)

# web/schema.ex
defmodule Blog.Schema do
  use Absinthe.Schema
  import_types Blog.Schema.Types

  query do
    @desc "Get a list of blog posts"
    field :posts, list_of(:post) do
      resolve &Blog.PostResolver.all/2
    end
  end
end

Reagiert auf { posts { ... } } und delegiert an Blog.PostResolver.all/2.

Resolver (Resolvers)

# web/resolvers/post_resolver.ex
defmodule Blog.PostResolver do
  def all(_args, _info) do
    {:ok, Blog.Repo.all(Blog.Post)}
  end
end

Resolver liefern {:ok, result} oder {:error, reason} zurueck.

Benutzerdefinierte Typen (Custom Types)

# web/schema/types.ex
defmodule Blog.Schema.Types do
  use Absinthe.Schema.Notation

  @desc "A blog post entity"
  object :post do
    field :id, :id
    field :title, :string
    field :body, :string
  end
end

Abfragen und Mutationen (Queries & Mutations)

Abfrage-Argumente (Query Arguments)

{
  user(id: "1") {
    name
    email
  }
}

# web/schema.ex
query do
  field :user, type: :user do
    arg :id, non_null(:id)
    resolve &Blog.UserResolver.find/2
  end
end

def find(%{id: id} = _args, _info) do
  case Blog.Accounts.get_user(id) do
    nil -> {:error, "User not found"}
    user -> {:ok, user}
  end
end

Mutationen (Mutations)

mutation CreatePost {
  post(title: "Hello World") {
    id
    title
  }
}

# web/schema.ex
mutation do
  @desc "Create a new post"
  field :post, type: :post do
    arg :title, non_null(:string)
    resolve &Blog.PostResolver.create/2
  end
end