带有Accept Header应用程序/ json的REST API返回一个数字

时间:2015-01-06 16:15:17

标签: json rest http

新手问题:

我的应用程序中有一个休息api:https://hostname/app-rest/session/manager/active-session/count。 API返回具有某些属性(如连接类型,状态等)的会话数。

当我设置请求标头Content-Type: application/json时,响应标头Accept: application/json并发送一个请求,如下所示: {"loggedIn": "yes", connectionType" : "mobile"},我得到一个数字为0,1,2等的回复

问题:基于此:http://json.org/,似乎响应是有效的JSON格式。但是,这是一个很好的设计实践吗?是不是最好以键值对格式返回值,以便所有客户端都能理解并解析响应 - 而不是假设客户端知道API返回的内容?

1 个答案:

答案 0 :(得分:2)

根据original RFC,一个数字本身就是 一个有效的JSON文本。 JSON必须始终以{[开头(可选地前面有一些空白字符)。

有一个new RFC通过允许任何JSON值成为整个JSON文本来修改它。如果你使用这个RFC,那么一个数字本身就是calid JSON。

暂时我建议返回一个对象,其中一个键描述返回的数字的含义,因为这将符合两个RFC。