Referência rápida

Folha de dicas do Phoenix Plug.Conn

Guia rapido de referencia para Plug.Conn no Phoenix: inspecao de parametros de requisicao, headers de resposta, cookies, redirecionamentos e parada de pipelines.

· Publicado

No framework Phoenix do Elixir, Plug.Conn representa tanto a requisicao quanto a resposta HTTP como uma struct imutavel transformada atraves de plugs.

Inspecionando requisições (Inspecting Incoming Requests)

conn.host          # => "example.com"
conn.method        # => "GET", "POST", etc.
conn.path_info     # => ["users", "42"]
conn.request_path  # => "/users/42"
conn.query_string  # => "tab=activity&sort=desc"
conn.port          # => 443
conn.scheme        # => :https
conn.remote_ip     # => {127, 0, 0, 1}

# Acessar headers da requisicao
get_req_header(conn, "authorization") # => ["Bearer token_xyz"]

Enviando respostas HTTP (Sending HTTP Responses)

# Enviar resposta JSON
conn
|> put_status(200)
|> json(%{status: "ok", count: 42})

# Enviar resposta HTML
conn
|> put_status(200)
|> html("<h1>Welcome</h1>")

# Enviar texto simples
conn
|> put_status(404)
|> text("Not Found")

Redirecionamentos e controle de fluxo (Redirects & Flow Control)

# Redirecionamento local
redirect(conn, to: "/dashboard")

# Redirecionamento externo
redirect(conn, external: "https://example.com")

# Parar a execucao do pipeline (interrompe plugs seguintes)
conn
|> put_status(401)
|> text("Unauthorized")
|> halt()

Modificando headers e cookies (Modifying Headers & Cookies)

# Headers de resposta
conn
|> put_resp_header("x-frame-options", "DENY")
|> put_resp_content_type("application/pdf")

# Cookies
conn
|> put_resp_cookie("session_id", "xyz", http_only: true, secure: true)
|> delete_resp_cookie("remember_token")

Referencias relacionadas

Temas relacionados