Question

规范中有一个items节点，表示该节点用于一系列项目，例如分页项，youtube视频列表

如果我对一个项目有GET请求，应该如何格式化响应？

只是数组中的一项？项目：[项目]

https://google.github.io/styleguide/jsoncstyleguide.xml

Answer 1

我不认为@tanmay_vijay的答案正确或微妙，因为似乎单项响应在文档的YouTube示例中位于数组中。

<div class="student"> Student 1 </div>
    <div class="student"> Student 2 </div>
    <div class="student"> Student 3 </div>
    <div class="student"> Student 4 </div>
    <div class="student"> Student 5 </div>

但是，这可能取决于请求所针对的资源。这就是竞争的JSONAPI标准中的方式。

根据JSONAPI标准：

逻辑上的资源集合必须表示为数组，即使它仅包含一项或为空。

Answer 2

您无需具有items字段即可显示单个项目。如果确定您的API总是要返回单个对象，则可以将其作为data本身返回。

{
  "data": {
    "kind": "user",
    "fields": "author,id",
    "id": "bart",
    "author": "Bart"
  }
}

data.kind data.fields data.etag data.id data.lang data.updated data.deleted之类的字段仍然可以在此处使用。

摘要docs

的来源

Google JSON样式指南：如何发送单项响应？

2 个答案: