构建API:JSON数组也适用于单元素数组?

时间:2013-04-15 17:01:19

标签: json api

我正在构建一个使用JSON进行请求/响应的API。我希望能够接收批量请求,即JSON Arrays。

现在,如果JSON请求始终包含在数组中,我有一个解决方案可以正常工作:

[
{"id":"AAAEEF", "value":"abc"}
]

也有效,

[
{"id":"AAAEEF", "value":"abc"},
{"id":"AAAEF1", "value":"vbc"},
]

如果只想请求一个id-value组合,那么请求

{"id":"AAAEEF", "value":"abc"}

请求失败。

我的问题:“好”API是否可以强制将所有JSON请求包装在一个数组中,即使它们只有一个元素?

先谢谢你帮助我!

1 个答案:

答案 0 :(得分:0)

编写“好”API的关键是保持一致,并将其记录下来。您接下来要做的是什么选择 - 如果您认为有充分的理由要求对API的所有调用应该包含在thisIsAContainerObject元素中,请务必记录并释放它。

为了保持一致性,总是需要一个数组甚至可能明显更好。只要在插入多个元素时抛出正确的错误。