Rest spec-返回json结构以获取参数列表

时间:2016-10-29 02:49:49

标签: json rest restful-architecture wcf-rest

我们有特定的业务要求:

1)公开一个接受id

列表的休息终点

2)假设我们要求10个ID,

  • 如果所有10个id都有有效数据,则返回数据的json数组
  • 如果某些数据存在问题,则应该选择返回无效状态的原因。例如:7个有效数据和3个无效数据 - 返回7个有效id的json数组和无效的返回错误消息。

这些是我们正在考虑的选项

选项1:

{
 "elements":[
 {"id":"valA", "name":"value", "regid":"value"}
 ,{"id":"valB", "name":"value", "regid":"value"}
 ,{"id":"valc", "name":"value", "regid":"value"}
 ],
 "invaliddata":[
 {"id":"valD", "Invalidreason":"id not found"},
 {"id":"valE", "invalidReason":"registration not found"}
 ]
}

如果所有id都有有效数据,我们将为invaliddata数组返回一个空数组。

Qn:如果没有id的匹配,在这种情况下我们应该返回404还是200并且所有id都在invaliddata数组中?

选项2。 在响应标头中发送自定义响应。标头将包含无效的ID 问:客户端是否更容易从标题与正文

中读取

选项3。 每个请求只接受1个id,如果未找到id则返回404,如果id具有无效数据,则返回404并显示错误消息。 问:404是无效数据的有效回复吗? (因为id在那里,技术上没有找到内容)

0 个答案:

没有答案