Question

134

Is a list/array valid JSON?

rated 0 times [ 140] [ 6] / answers: 1 / hits: 41220 / 11 Years ago, sun, october 27, 2013, 12:00:00

I wish to write a webservice which serves lists of JSON objects. Is it valid JSON to return the following:

[

  {keyA1:valA, keyB1:valB}

 ,{keyA2:valA, keyB2:valB}

 ,{keyA3:valA, keyB3:valB}

]

Or is the right way to do it to put it in a single object to return:

{elements:[

   {keyA1:valA, keyB1:valB}

  ,{keyA2:valA, keyB2:valB}

  ,{keyA3:valA, keyB3:valB}

]}

Answers

Only authorized users can answer the question. Please sign in first, or register a free account.

kamryn

Add To Favorites

Follow

Total Points: 645

Total Questions: 100

Total Answers: 118

Location: Tanzania

Member since Wed, Feb 24, 2021

3 Years ago

kamryn questions

1 import SVG as React Components with webpack 5

Sun, Apr 10, 22, 00:00, 2 Years ago

1 TS2339: Property 'id' does not exist on type '{}'

Sun, Oct 3, 21, 00:00, 3 Years ago

1 Getting req.headers is undefined when trying to read from req object in NextJS

Fri, Aug 21, 20, 00:00, 4 Years ago

1 Unsafe value used in a resource URL context (iframe)

Thu, May 28, 20, 00:00, 4 Years ago

1 Alert in if/else statement in React JS

Tue, May 12, 20, 00:00, 4 Years ago

View All

answered 11 Years ago kaylea · Accepted Answer

Both forms are valid. However, for an API, I would recommend the second form. The reason is that it gives you a path for expansion of your API.

For example, if you have an API getUsersInGroup which returns an array of user objects, and later you decide you want to include, say, some aggregate statistics about the users being returned, there's no easy way to do that without breaking existing clients (or including lots of redundant data in each user object). If you use an object, you simply add another field to the object which is silently ignored by clients on a previous version of the API.

In short, try to avoid top-level primitives wherever possible in your API, and you'll find it easier to expand in the future.