Google json风格指南:如何发送单项响应?

问题描述 投票:0回答:1

规范中有一个items节点,表示它是一个项目数组,如分页项目,youtube视频列表

如果我对单个项目有GET请求怎么办?如何格式化响应?

只是阵列中的一个项目?项目:[项目]

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

json openapi
1个回答
1
投票

您不需要使用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的来源

© www.soinside.com 2019 - 2024. All rights reserved.