jsonecho

JSON to Elm

Paste a JSON sample and get Elm types for it.

Loading the tool...

How to use JSON to Elm

  1. Paste a representative JSON sample, ideally one with all the optional fields filled in.
  2. Set the name of the root type, and decide whether you want helper code as well or types only.
  3. Copy the generated Elm code into your project.

About JSON to Elm

Writing model classes by hand for a big JSON payload is dull, and it is where typos creep in. Paste a sample here and the generator works out the structure: which fields exist, which are objects, which are arrays and what type each value has. The output is type aliases with matching JSON decoders and encoders.

Elm has no runtime reflection, so the decoders are generated for you, and they are the most useful part of the output. Everything runs in your browser, so your sample data stays on your machine.

Using the generated code

Use Json.Decode.decodeString rootDecoder text and handle the Result, which tells you what went wrong if the data does not match.

Optional values use the Maybe type and the decoder accepts null and missing keys.

Frequently asked questions

What does the generated Elm code depend on?

The output is type aliases with matching JSON decoders and encoders.

How do I parse JSON with the result?

Use Json.Decode.decodeString rootDecoder text and handle the Result, which tells you what went wrong if the data does not match.

How are optional and missing fields handled?

Optional values use the Maybe type and the decoder accepts null and missing keys.

Does the generator look at more than one record?

It only knows what is in your sample. If a field is missing from your example, it will not appear in the types, and if a value is null in your example, its type is unknown. Paste an example in which as many fields as possible are filled in, or paste an array with several different records.

Is my JSON sent to a server?

No. The generator is downloaded to your browser the first time you use it, about 1 MB, and everything runs locally.

More in Data to Class

All tools →