neuone

neuone

SCENARIO

I have this 3rd party API JSON that has it’s keys in TitleCase format. These API calls are all “GET” requests.

“MetaData” => %{
“UserName” => …
“LastName” => …
}%

I want to convert the keys from Titlecase to lowercase atom keys before I start to internally break down the json into internal structs.

HTTP Client

Tesla for my HTTP Client

Option 1 - Tesla Middleware JSON Engine Options

I was reading the Tesla.Middleware.JSON docs and I saw this option engine_opts: [keys: :atoms].

defmodule Api.Client.Base do

  use Tesla
  plug Tesla.Middleware.BaseUrl, "http://somewebsite.com"
  plug Tesla.Middleware.JSON, engine_opts: [keys: :atoms]

But this converts my JSON from MetaData to metaData for the keys. Not ideal as I want them to be lowercase and underscore. So ideally meta_data

Option 2 - Build my own Middleware

I have never done this before but the instructions and documentation make it easy

defmodule Api.Client.InspectHeadersMiddleware do
  
  @behaviour Tesla.Middleware
  
  def call(env, next, _) do
    env
    |> Tesla.run(next)
    |> decode_json()
  end

  def decode_json(env) do
    with  {:ok, tesla_struct} <- env,
          {:ok, json} <- convert_to_json(tesla_struct),
          results <-  keys_to_underscore(json) do
      {:ok, put_in(tesla_struct.body, results)}
    end
  end


  def convert_to_json(strct) do
    strct.body
    |> Jason.decode()
  end

  def keys_to_underscore(json) when is_map(json) do
    Map.new(json, &reduce_keys_to_underscore/1)
  end

  def reduce_keys_to_underscore({key, val}) when is_map(val), do: {string_to_atom(key), keys_to_underscore(val)}
  def reduce_keys_to_underscore({key, val}) when is_list(val), do: {string_to_atom(key), Enum.map(val, &keys_to_underscore(&1))}
  def reduce_keys_to_underscore({key, val}), do: {string_to_atom(key), val}

  def string_to_atom(key) do
    Macro.underscore(key)
    |> String.to_atom
  end

end

And then I make sure to place my middleware plug Api.Client.InspectHeadersMiddleware after the Tesla.Middleware.JSON

defmodule Api.Client.Base do

  use Tesla
  plug Tesla.Middleware.BaseUrl, "http://somewebsite.com"
  plug Tesla.Middleware.JSON
  plug Api.Client.InspectHeadersMiddleware

Conclusion

And this works but I have concerns and need some feedback.

QUESTIONS

1. Other possible solutions?
Has anyone had to deal with a similar situation? Any open source libraries I should check out?

2. The process of converting 3rd party JSON API keys and String.to_atom
I’m reading posts that suggest converting keys to atoms from 3rd party sources can be dangerous due to garbage collection limit String.to_atom, When to use Elixir String.to_atom and even this post

3. Is my solution putting me in danger
Is using a Middleware approach ideal OR is there something better?
The API requests are just GET requests and I do trust the service.
And I do know what the keys will be for each endpoint.

Thanks

Showing Posts 1 to 4

stefanchrobot

stefanchrobot

Custom middleware that converts keys is the way to go. The idea behind middlewares was to provide an extension point. So something like:

defmodule Api.Client.Base do
  use Tesla
  plug Tesla.Middleware.JSON
  # Once this middleware is called, the body is already deserialized from JSON.
  plug KeyConversionMiddleware
end

would do the job.

I would suggest keeping the keys as strings, exactly for the reasons you’ve mentioned. Consider using Ecto schemas and changesets to validate the incoming requests and convert them to structs - it will convert the string keys for you.

neuone

neuone OP

I have done what you suggested and just kept the 3rd party api keys as strings but converted to “lowercase” and then through some module and then using Ecto.Schema to cast the string keys.

Helpful tip and good to know my approach is ideal.

Thanks for the feedback.

Wigny

Wigny

I came across the same problem converting cases, so create a package to be able to reuse the approach in other projects: TeslaKeys.Middleware.Case — tesla_keys v0.3.0

neuone

neuone OP

Thanks. Will try this out in another project.

— 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
kpanic
Hi everyone, I am toying with the idea of building a “match maker” for giving personal help to people that wants to start coding. I sta...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
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
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
apz
I’m new to elixir and just tried to install the elixirLS extension for VScode(ium) and it is throwing some errors that I would like help ...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
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

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews