inhji

inhji

Phoenix Controller: Matching on content-type

Hi there,

I have a controller with an action that renders some html. Now I want to extend that action to render some json when the content type is application/json*

I was hoping I could use pattern matching to achieve this, but this does not work (the html action always gets executed):

  def index(%{req_headers: [{"content-type", "application/json"}]} = conn, _params) do
    json(conn, %{some: "response"})
  end

  def index(conn, _params) do
    render(conn, "index.html")
  end

This does work:

  def index(conn, _params) do
    headers = Enum.into(conn.req_headers, %{})

    if headers["content-type"] == "application/json" do
      json(conn, %{some: "response"})
    else
      render(conn, "index.html")
    end
  end

Is there a cleaner to achieve this?

Thanks!

Marked As Solved

AlchemistCamp

AlchemistCamp

Another option you have is to define a render function for both an index.html and an index.json and then just pass the action’s atom to the render function in your controller. In other words instead of having render(conn, "index.html"...), you’ll have render(conn, :index...). Here’s an example from one of my apps:

card_controller.ex:

  #...
  def index(conn, _params) do
    cards = Task.list_cards()
    render(conn, :index, cards: cards)
  end
  #...
  def show(conn, %{"id" => id}) do
    card = Task.get_card!(id)
    render(conn, :show, card: card)
  end
  #...

With this in place, Phoenix will look for the appropriate (view) render function or template for each content type. You could have an index.html.eex, an index.json.eex, an index.xml.eex and even more options all in the same template directory.

What I often do with JSON is just define a render function directly in the view instead of making a template, since it’s so short and Phoenix will automatically use Jason (or whichever encoder you’ve configured) to encode your data properly.

card_view.ex:

defmodule MellowWeb.CardView do
  use MellowWeb, :view

  def render("index.json", %{cards: cards}), do: cards
  def render("show.json", %{card: card}), do: card
end

As @voltone pointed out, you’ll need to make sure your router plug accepts includes JSON and then Phoenix will honor the Accept header coming from the front end.

Using axios (or Vue.axios in my case), you can do that with the headers field like this:

Vue.axios({
  method: "POST",
  url: "/cards",
  data: data,
  headers: { Accept: "application/json" }
})

Also Liked

voltone

voltone

The “Content-Type” header describes the payload of the client’s request. The response format is normally negotiated based on the client’s “Accept” header and the server’s capabilities.

See:
https://hexdocs.pm/phoenix/Phoenix.Controller.html#accepts/2
https://hexdocs.pm/phoenix/Phoenix.Controller.html#get_format/1

In a standard Phoenix application you should already have something like plug :accepts, ["html"] in one of your router’s pipelines. You can update it to ["html", "json"], make sure your client sends the correct “Accept” header and check get_format(conn) when choosing what to render.

BTW, the reason pattern matching does not work is because it will only match a list where the only element is {"content-type", "application/json"}, which is never the case.

NobbZ

NobbZ

index is usally called on a GET request, and setting a content-type header does not make much sense there.

Besides of that, you match on a list that has exactly one element. This is unlikely to be true for any list of headers.

Also I’m seconding @voltone, that you probably want to check for the "accept" header instead and leverage plugs that are already available.

kokolegorille

kokolegorille

Where Next?

Popular in Questions Top

9mm
I am constructing a JSON object (map) and I need to conditionally set a field. I’m trying to write proper elixir-way code… and I’m at a l...
New
shahryarjb
Hello, I get Persian date from my client and convert it to normal calendar like this: def jalali_string_to_miladi_english_number(persi...
New
chrisalley
ExUnit now has describe blocks which is a welcome addition coming from RSpec. In the docs, it states that nested hierarchies of describe ...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
jerry
Good day to you all. I have been struggling to get a query involving like and ilike to work. Can anyone assist me on this, please? pro...
New
jay1
Why is it that the mnesia database isn’t the most preferred database for use in Elixir/Phoenix?
New
baxterw3b
Hi guys, i’m new in the Elixir world, and i have to say, that i love it! i’m having some problem to understand anonymous functions with ...
New
joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 record...
New
svb
Hi! Currently I want to submit a form by pressing the Enter key. However, since my input field is of type “textarea” this is just adds a...
New

Other popular topics Top

siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New
TunkShif
This post is an instruction guide to help you setup your Neovim for Elixir development from scratch. It includes general information on h...
274 41454 115
New
chrismccord
As promised, the first release candidate of Phoenix 1.3.0 is out! This release focuses on code generators with improved project structure...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
JorisKok
I have a server on AWS, and was running a load test using artillery. When looking at the Phoenix dashboard I see the Ports going to 100% ...
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
vegabook
I'm brand new to Phoenix and I have stripped one of the demo applications to the bone. I just want to get an svg up on the screen. Here i...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 record...
New

We're in Beta

About us Mission Statement