how to format Json output?

Question

My web service responses has mimetype: "application/json" and my JSON outputs without spacing, like this

1

{"Data":{"Item":"123","Timestamp":"2011-11-24T17:50:43"}}

When the JSON should output like this

2

{
   "Data":{
      "Item":"123",
      "Timestamp":"2011-11-24T17:50:43"
   }
}

Is there any way I can fix the JSON format, so it appears like #2?

You say it "should" look like that - why? It's nice to be *able* to format it, but it's important to understand that the two versions are equivalent as far as the JavaScript consuming the data is concerned. — Jon Skeet, Nov 24 '11 at 07:05
In addition to @JonSkeet - formating you JSON nicelly will add just a bit more of overhead (because the whitespace characters will need to be transfered through the wire as well). — Pavel Donchev, Nov 24 '11 at 07:11

score 23 · Accepted Answer · answered Nov 24 '11 at 07:07

23

I wouldn't change the format written out by the web service, but if you want to format it for diagnostic purposes you can use Json.NET to do this very simply:

JObject json = JObject.Parse(text);
string formatted = json.ToString();

The result is automatically formatted. You could put this into a small tool - either a desktop tool or a web page somewhere. (I wouldn't be surprised if there were already online JSON formatters, although obviously you'd want to be careful about formatting sensitive data.)

answered Nov 24 '11 at 07:07

Jon Skeet

1,421,763
867
9,128
9,194

1

Fiddler from Telerik format the JSON response nicely. – Diganta Kumar Sep 21 '12 at 08:10
Why should I be careful about formatting sensitive data? – Ascendant Feb 21 '14 at 00:52
2

@ZinanXing: Look at the context of the sentence: *online JSON formatters*. If you've got private information about your customers, how do you think they'd feel about you submitting them (probably over HTTP) to some 3rd party website for formatting? – Jon Skeet Feb 21 '14 at 06:42
@JonSkeet: Makes perfect sense. – Ascendant Feb 21 '14 at 06:49

score 3 · Answer 2 · answered Mar 26 '13 at 09:40

Jon's answer doesn't seem to work if the root element of your json is an array. Using JToken instead of JObject fixed this for me. As an extension method on string, this looks like:

public static string FormatJson(this string json)
{
    return JToken.Parse(json).ToString();
}

score -1 · Answer 3 · answered Nov 24 '11 at 07:09

-1

If you call your service from Firefox there's this nice plugin that will prettify the JSON for you: JSONView

I also used to use this website to format and validate any JSON: JSON Formatter

answered Nov 24 '11 at 07:09

CyberDude

8,541
5
29
47

2

OP wants it to be done programatically using C# – Nitin Sawant May 20 '14 at 12:16

how to format Json output?

1

2

3 Answers3

Linked