Referência rápida

Folha de dicas do Phoenix Framework

Guia rapido e completo para Phoenix em Elixir: inicio rapido, estrutura de diretorios, roteamento, pipelines Plug.Conn, controladores e geradores.

· Publicado

Phoenix e um framework web confiavel e altamente produtivo baseado no runtime BEAM de Elixir e Erlang.

Início rápido (Quickstart)

# Instalar gerenciador de pacotes Hex e arquivo do Phoenix
mix local.hex
mix archive.install hex phx_new

# Gerar nova aplicacao Phoenix com PostgreSQL
mix phx.new my_app

# Iniciar o servidor de desenvolvimento interativo
mix phx.server

Estrutura de diretórios (Application Directory Layout)

my_app/
├── assets/          # Recursos frontend (esbuild, Tailwind CSS)
├── config/          # Configuracao de ambiente (dev, test, prod)
├── lib/
│   ├── my_app/      # Logica de dominio e esquemas Ecto
│   ├── my_app.ex
│   └── my_app_web/  # Camada web (controladores, views, roteador)
│       ├── controllers/
│       ├── router.ex
│       └── endpoint.ex
├── priv/
│   └── repo/        # Migracoes de banco de dados e dados seed
└── test/            # Suites de testes ExUnit

Controladores e pipelines (Controllers & Pipelines)

Phoenix utiliza Plug.Conn como estrutura unificada de transformacao HTTP:

defmodule MyAppWeb.UserController do
  use MyAppWeb, :controller

  def show(conn, %{"id" => id}) do
    user = MyApp.Accounts.get_user!(id)

    conn
    |> put_status(200)
    |> render("show.html", user: user)
  end

  def api_index(conn, _params) do
    users = MyApp.Accounts.list_users()
    json(conn, %{data: users})
  end
end

Geradores e contextos (Generators & Contexts)

# Gerar contexto CRUD HTML completo, esquema e controlador
mix phx.gen.html Accounts User users name:string email:string:unique

# Gerar recursos de API JSON
mix phx.gen.json Catalog Product products title:string price:decimal

# Executar migracoes de banco de dados
mix ecto.migrate

Referencias relacionadas

Temas relacionados