Structure - Google 风格指南中文版

JSON 结构和保留属性名

为了保持 API 之间一致的接口，JSON 对象应遵循下面概述的结构。此结构适用于使用 JSON 的请求和响应。在此结构中，某些属性名被保留用于特定用途。这些属性不是必需的；换句话说，每个保留属性可以出现零次或一次。但如果服务需要这些属性，建议使用此命名约定。以下是以 Orderly 格式表示的 JSON 结构模式（它可以编译为 JSONSchema ）。你可以在本指南的末尾看到 JSON 结构的示例。


object {
  string apiVersion?;
  string context?;
  string id?;
  string method?;
  object {
    string id?
  }* params?;
  object {
    string kind?;
    string fields?;
    string etag?;
    string id?;
    string lang?;
    string updated?; # 按 RFC 3339 格式化的日期
    boolean deleted?;
    integer currentItemCount?;
    integer itemsPerPage?;
    integer startIndex?;
    integer totalItems?;
    integer pageIndex?;
    integer totalPages?;
    string pageLinkTemplate /^https?:/ ?;
    object {}* next?;
    string nextLink?;
    object {}* previous?;
    string previousLink?;
    object {}* self?;
    string selfLink?;
    object {}* edit?;
    string editLink?;
    array [
      object {}*;
    ] items?;
  }* data?;
  object {
    integer code?;
    string message?;
    array [
      object {
        string domain?;
        string reason?;
        string message?;
        string location?;
        string locationType?;
        string extendedHelp?;
        string sendReport?;
      }*;
    ] errors?;
  }* error?;
}*;

JSON 对象有一些顶层属性，后面跟着 data 对象或 error 对象，但不能同时包含两者。每个属性的说明见下文。