data对象的保留属性名 · Google 开源项目风格指南 (中文版)

JSON对象的_data_属性可能包含以下属性。 ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#datakind)data.kind ~~~ 属性值类型: 字符串(sting) 父节点: data ~~~ _kind_属性是对某个特定的对象存储何种类型的信息的指南。可以把它放在_data_层次，或_items_的层次，或其它任何有助于区分各类对象的对象中。如果_kind_对象被提供，它应该是对象的第一个属性（详见下面的_属性顺序_部分）。示例： ~~~ // "Kind" indicates an "album" in the Picasa API. {"data": {"kind": "album"}} ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#datafields)data.fields ~~~ 属性值类型: 字符串(string) 父节点: data ~~~ 表示做了部分GET之后响应中出现的字段，或做了部分PATCH之后出现在请求中的字段。该属性仅在做了部分GET请求/批处理时存在，且不能为空。示例： ~~~ { "data": { "kind": "user", "fields": "author,id", "id": "bart", "author": "Bart" } } ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#dataetag)data.etag ~~~ 属性值类型: 字符串(string) 父节点: data ~~~ 响应时提供etag。关于GData APIs中的ETags详情可以在这里找到：[http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning](http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning) 示例： ~~~ {"data": {"etag": "W/"C0QBRXcycSp7ImA9WxRVFUk.""}} ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#dataid)data.id ~~~ 属性值类型: 字符串(string) 父节点: data ~~~ 一个全局唯一标识符用于引用该对象。_id_属性的具体细节都留给了服务。示例： ~~~ {"data": {"id": "12345"}} ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#datalang)data.lang ~~~ 属性值类型: 字符串(string)(格式由BCP 47指定) 父节点: data (或任何子元素) ~~~ 表示该对象内其他属性的语言。该属性模拟HTML的_lang_属性和XML的_xml:lang_属性。值应该时BCP 47中定义的一种语言值。如果一个单一的JSON对象包含的数据有多种语言，服务负责制定和标明的lang属性的适当位置。示例： ~~~ {"data": { "items": [ { "lang": "en", "title": "Hello world!" }, { "lang": "fr", "title": "Bonjour monde!" } ]} } ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#dataupdated)data.updated ~~~ 属性值类型: 字符串(string)(格式由RFC 3339指定) 父节点: data ~~~ 指明条目更新的最后日期/时间(RFC 3339)，由服务规定。示例： ~~~ {"data": {"updated": "2007-11-06T16:34:41.000Z"}} ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#datadeleted)data.deleted ~~~ 属性值类型: 布尔(boolean) 父节点: data (或任何子元素) ~~~ 一个标记元素，当出现时，表示包含的条目已被删除。如果提供了删除属性，它的值必须为_true_;为_false_会导致混乱，应该避免。示例： ~~~ {"data": { "items": [ { "title": "A deleted entry", "deleted": true } ]} } ~~~ ### [](https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md#dataitems)data.items ~~~ 属性值类型: 数组(array) 父节点: data ~~~ 属性名_items_被保留用作表示一组条目(例如,Picasa中的图片，YouTube中的视频)。这种结构的目的是给与当前结果相关的集合提供一个标准位置。例如，知道页面上的_items_是数组，JSON输出便可能插入一个通用的分页系统。如果_items_存在，它应该是_data_对象的最后一个属性。（详见下面的_属性顺序_部分）。示例： ~~~ { "data": { "items": [ { /* Object #1 */ }, { /* Object #2 */ }, ... ] } } ~~~