Referência rápida

Folha de dicas do Absinthe GraphQL

Guia rapido de referencia para Absinthe GraphQL em Elixir e Phoenix: esquemas, resolvers, tipos, consultas e mutacoes.

· Publicado

Absinthe e o kit completo de ferramentas GraphQL para aplicacoes Elixir e Phoenix.

Conceitos fundamentais (Core Concepts)

  • Schema: A definicao raiz de consultas, mutacoes e tipos.
  • Resolver: A funcao Elixir responsavel por buscar ou modificar dados.
  • Type: Define a estrutura e os campos das entidades de dados.

Integração Plug no Phoenix

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

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

Absinthe opera como um Plug que aceita a configuracao do seu esquema raiz.


Definição do esquema (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

Responde a { posts { ... } } e delega a execucao ao resolver.

Resolvers

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

Resolvers retornam {:ok, result} ou {:error, reason}.

Tipos customizados (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

Consultas e mutações (Queries & Mutations)

Argumentos de consulta

{
  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

Mutações (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

Referencias relacionadas

Temas relacionados