matiso

matiso

I’ve found, that the default JSON responses from Phoenix, are not “pretty” (they have no linebreaks across the JSON structure, keys and values are rendered one after another). That might be OK for many use cases, but sometimes your API responses might be better if they can generate “pretty JSON”.

One way to achieve that in Phoenix is by defining following the following function and using it in a controller:

  def pretty_json(conn, data) do
    conn
    |> Plug.Conn.put_resp_header("content-type", "application/json; charset=utf-8")
    |> Plug.Conn.send_resp(200, Poison.encode!(data, pretty: true))
  end

This can’t be done in a view, though, and leads to lots of repetitions. So if you want to represent a specific view of your data in pretty JSON, you have to do it entirely in the controller, skipping the more usual / recommended render(conn, FooView, "foo.json", data) pattern.

Maybe there could be an option in the framework to enable pretty JSON by default? Or an additional argument for the render function that could enable it? Or maybe a plug that would post-process the result of rendering a view?

Thanks for all your feedback!

Showing Posts 1 to 4

michalmuskala

michalmuskala

You can set a custom format encoder to a module, where you’d call Poison.encode(data, pretty: true).

config :phoenix, :format_encoders,
  html: Phoenix.HTML.Engine,
  json: PrettyJson

The documentation is here in the “Format encoders” section.

I wonder what’s the use case of emitting a prettified JSON. Is it to make it human readable?

matiso

matiso OP

This is great, thank you!

Yes, that’s pretty much it. Of course it’s not strictly necessary, but it makes it easier for copying & sending data to people when you don’t have a proper UI for it.

OvermindDL1

OvermindDL1

I use a plugin in chrome to view JSON well (with lots of cool options) and a pretty prettier that I can pipe curl into for the command prompt, why would you want to inflate the network usage?

jung-hunsoo

jung-hunsoo

I’m using ProperCase dependency. It’s lightweight and easy to config.

— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

Latest on Elixir Forum

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews