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:

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.

Last Post!

inhji

inhji

Thank you everybody for your answers!
I tried two approaches:

The first one involved a plug that called get_format and put its output to the private map. This lets me pattern match on the format like i originally imagined:

defmodule AkediaWeb.Plugs.PlugFormat do
  import Plug.Conn, only: [put_private: 3]
  import Phoenix.Controller, only: [get_format: 1]

  def put_req_format(conn, opts) do
    put_private(conn, :plug_format, get_format(conn))
  end
end

..

def index(%{private: %{plug_format: "html"}} = conn, params) do
# html response
end

def index(%{private: %{plug_format: "json"}} = conn, params) do
# json response
end

The approach as outlined by @AlchemistCamp ended up being more appealing to me because all I had to do was adding the json render function to the view and changing the render function in the controller:

# from 
render(conn, "show.html", user: user)
# to
render(conn, :show, user: user)

Where Next?

Popular in Questions Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
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 records...
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
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
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
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
senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New

Other popular topics Top

Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
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
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
New
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
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New

We're in Beta

About us Mission Statement