Root Nodes in JSON

Question

I'm tasked with defining communication between two web apps. I've decided to use JSON for this. How common is it to have a root node in the JSON? Let's say we have a car object. This is the JSON with "Car" being the root node: ``` {"Car": { "Make":"Mustang", "YearBuilt":"1999"}} ``` So now let's say I have a Tire object and since we are standardizing on having root nodes, this one also has to have it. ``` {"Tire": {"Make": "Brirdgestone", "Size":"15"}} ``` Integrating the tire object JSON into the original Car object shows how unwieldy it could be. ``` {"Car": { "Make":"Mustang", "YearBuilt":"1999", "Tires": "[{"Tire": {"Make": "Brirdgestone", "Size":"15"}}, {"Tire": {"Make": "Brirdgestone", "Size":"15"}}, {"Tire": {"Make": "Bridgestone", "Size":"15"}}, {"Tire": {"Make": "Brirdgestone", "Size":"15"}} ]}} ``` So serialized in PHP, the make of the first Tire would be `$object->Car->Tires[0]->Tire->Make`. There's that extra Tire level there because of the root node. If Tire did not have…

Accepted Answer

I'd omit both root nodes, Tire and Car.

Keep in mind that JSON's primary use is transfering objects over the network in a compact format. There is no real other usage beside this. You want to work with the data the JSON encodes and by adding the root nodes, you are creating empty container objects with no real identity and purpose. When omiting the root nodes, you get

```
$car->tires[0]->make
```

and in JS you'd get

```
car.tires[0].make
```

This is much clearer and represents the object much better. Remember, this is what you will have to work with. Sure, you could use some sort of JSON mapper that maps how objects should be serialized and that result in the above objects, but that's a lot of extra effort and not worth it imho.

If you want to have the class name in the JSON, just make it a property, e.g.

```
{ 'klass': 'Car', 'make': 'Mustang', 'year':1999 }
```

Root Nodes in JSON

Solution

Problem