Json風格指南
英文版：http://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml
翻譯：Darcy Liu
簡介
該風格指南是對在Google建立JSON APIs而提供的指導性準則和建議。總體來講，JSON APIs應遵循JSON.org上的規範。這份風格指南澄清和標準化了特定情況，從而使Google的JSON APIs有一種標準的外觀和感覺。這些指南適用於基於RPC和基於REST風格的API的JSON請求和響應。
定義
為了更好地實現這份風格指南的目的，下面幾項需要說明：
屬性(property) - JSON物件內的鍵值對(name/value pair)
屬性名(property name) - 屬性的名稱(或鍵)
屬性值(property value) - 分配給屬性的值
示例：
{
// 一組鍵值對稱作一個 "屬性".
"propertyName": "propertyValue"
}
Javascript的數字(number)包含所有的浮點數,這是一個寬泛的指定。在這份指南中，數字(number)指代Javascript中的數字(number)型別，而整型(integer)則指代整型。
一般準則
註釋
JSON物件中不包含註釋。
JSON物件中不應該包含註釋。該指南中的某些示例含有註釋。但這僅僅是為了說明示例。
{
// 你可能在下面的示例中看到註釋,
// 但不要在你的JSON資料中加入註釋.
"propertyName": "propertyValue"
}
雙引號
使用雙引號
如果（某個）屬性需要引號，則必須使用雙引號。所有的屬性名必須在雙引號內。字元型別的屬性值必須使用雙引號。其它型別值（如布林或數字）不應該使用雙引號。
扁平化資料 VS 結構層次
不能為了方便而將資料任意分組
JSON中的資料元素應以扁平化方式呈現。不能為了方便而將資料任意分組。
在某些情況下，比如描述單一結構的一批屬性，因為它被用來保持結構層次，因而是有意義的。但是遇到這些情況還是應當慎重考慮，記住只有語義上有意義的時候才使用它。例如，一個地址可以有表示兩種方式，但結構化的方式對開發人員來講可能更有意義：
扁平化地址:
{
"company": "Google",
"website": "http://www.google.com/",
"addressLine1": "111 8th Ave",
"addressLine2": "4th Floor",
"state": "NY",
"city": "New York",
"zip": "10011"
}
結構化地址：
{
"company": "Google",
"website": "http://www.google.com/",
"address": {
"line1": "111 8th Ave",
"line2": "4th Floor",
"state": "NY",
"city": "New York",
"zip": "10011"
}
}
屬性名準則
屬性名格式
選擇有意義的屬性名
屬性名必須遵循以下準則:
屬性名應該是具有定義語義的有意義的名稱。
屬性名必須是駝峰式的，ASCII碼字串。
首字元必須是字母，下劃線(_)或美元符號($)。
隨後的其他字元可以是字母，數字，下劃線(_)或美元符號($)。
應該避免使用Javascript中的保留關鍵字(下文附有Javascript保留字清單)
這些準則反映JavaScript識別符號命名的指導方針。使JavaScript的客戶端可以使用點符號來訪問屬性。(例如,result.thisIsAnInstanceVariable).
下面是一個物件的一個屬性的例子：
{
"thisPropertyIsAnIdentifier": "identifier value"
}
JSON Map中的鍵名
在JSON Map中鍵名可以使用任意Unicode字元
當JSON物件作為Map(對映)使用時，屬性的名稱命名規則並不適用。Map（也稱作關聯陣列）是一個具有任意鍵/值對的資料型別，這些鍵/值對通過特定的鍵來訪問相應的值。JSON物件和JSON Map在執行時看起來是一樣的；這個特性與API設計相關。當JSON物件被當作map使用時，API檔案應當做出說明。
Map的鍵名不一定要遵循屬性名稱的命名準則。鍵名可以包含任意的Unicode字元。客戶端可使用maps熟悉的方括號來訪問這些屬性。（例如result.thumbnails["72"]）
{
// "address" 屬性是一個子物件
// 包含地址的各部分.
"address": {
"addressLine1": "123 Anystreet",
"city": "Anytown",
"state": "XX",
"zip": "00000"
},
// "address" 是一個對映
// 含有響應規格所對應的URL，用來對映thumbnail url的畫素規格
"thumbnails": {
"72": "http://url.to.72px.thumbnail",
"144": "http://url.to.144px.thumbnail"
}
}
保留的屬性名稱
某些屬性名稱會被保留以便能在多個服務間相容使用
保留屬性名稱的詳細資訊，連同完整的列表，可在本指南後面的內容中找到。服務應按照被定義的語義來使用屬性名稱。
單數屬性名 VS 複數屬性名
陣列型別應該是複數屬性名。其它屬性名都應該是單數。
陣列通常包含多個條目，複數屬性名就反映了這點。在下面這個保留名稱中可以看到例子。屬性名items是複數因為它描述的是一組物件。大多數的其它欄位是單數。
當然也有例外，尤其是涉及到數字的屬性值的時候。例如，在保留屬性名中，totalItems 比 totalItem更合理。然後，從技術上講，這並不違反風格指南，因為 totalItems 可以被看作 totalOfItems, 其中 total 是單數（依照風格指南），OfItems 用來限定總數。欄位名也可被改為 itemCount，這樣看起來更象單數.
{
// 單數
"author": "lisa",
// 一組同胞, 複數
"siblings": [ "bart", "maggie"],
// "totalItem" 看起來並不對
"totalItems": 10,
// 但 "itemCount" 要好些
"itemCount": 10
}
命名衝突
通過選擇新的屬性名或將API版本化來避免命名衝突
新的屬性可在將來被新增進保留列表中。JSON中不存在名稱空間。如果存在命名衝突，可通過選擇新的屬性名或者版本化來解決這個問題。例如，假設我們由下面的JSON物件開始：
{
"apiVersion": "1.0",
"data": {
"recipeName": "pizza",
"ingredients": ["tomatoes", "cheese", "sausage"]
}
}
如果我們希望將來把ingredients列為保留字，我們可以通過下面兩件事情來達成:
1.選一個不同的名字
{
"apiVersion": "1.0",
"data": {
"recipeName": "pizza",
"ingredientsData": "Some new property",
"ingredients": ["tomatoes", "cheese", "sausage"]
}
}
2.在主版本上重新命名屬性
{
"apiVersion": "2.0",
"data": {
"recipeName": "pizza",
"ingredients": "Some new property",
"recipeIngredients": ["tomatos", "cheese", "sausage"]
}
}
屬性值準則
屬性值格式
屬性值必須是Unicode 的 booleans（布林）, 數字(numbers), 字串(strings), 物件(objects), 陣列(arrays), 或 null.
JSON.org上的標準準確地說明了哪些型別的資料可以作為屬性值。這包含Unicode的布林(booleans), 數字(numbers), 字串(strings), 物件(objects), 陣列(arrays), 或 null。JavaScript表示式是不被接受的。APIs應該支援該準則，併為某個特定的屬性選擇最合適的資料型別（比如，用numbers代表numbers等）。
好的例子：
{
"canPigsFly": null, // null
"areWeThereYet": false, // boolean
"answerToLife": 42, // number
"name": "Bart", // string
"moreData": {}, // object
"things": [] // array
}
不好的例子：
{
"aVariableName": aVariableName, // Bad - JavaScript 識別符號
"functionFoo": function() { return 1; } // Bad - JavaScript 函式
}
空或Null 屬性值
考慮移除空或null值
如果一個屬性是可選的或者包含空值或null值，考慮從JSON中去掉該屬性，除非它的存在有很強的語義原因。
{
"volume": 10,
// 即使 "balance" 屬性值是零, 它也應當被保留,
// 因為 "0" 表示 "均衡"
// "-1" 表示左傾斜和"＋1" 表示右傾斜
"balance": 0,
// "currentlyPlaying" 是null的時候可被移除
// "currentlyPlaying": null
}
列舉值
列舉值應當以字串的形式呈現
隨著APIs的發展，列舉值可能被新增，移除或者改變。將列舉值當作字串可以使下游使用者幽雅地處理列舉值的變更。
Java程式碼：
public enum Color {
WHITE,
BLACK,
RED,
YELLOW,
BLUE
}
JSON物件：
{
"color": "WHITE"
}
屬性值資料型別
上面提到，屬性值必須是布林(booleans), 數字(numbers), 字串(strings), 物件(objects), 陣列(arrays), 或 null. 然而在處理某些值時，定義一組標準的資料型別是非常有用的。這些資料型別必須始終是字串，但是為了便於解析，它們也會以特定的方式被格式化。
日期屬性值
日期應該使用RFC3339建議的格式
日期應該是RFC 3339所建議的字串格式。
{
"lastUpdate": "2007-11-06T16:34:41.000Z"
}
時間間隔屬性值
時間間隔應該使用ISO 8601建議的格式
時間間隔應該是ISO 8601所建議的字串格式。
{
// 三年, 6個月, 4天, 12小時,
// 三十分鐘, 5秒
"duration": "P3Y6M4DT12H30M5S"
}
緯度/經度屬性值
緯度/經度應該使用ISO 6709建議的格式
緯度/經度應該是ISO 6709所建議的字串格式。 而且, 它應該更偏好使用 e ±DD.DDDD±DDD.DDDD 角度格式.
{
// 自由女神像的緯度/經度位置.
"statueOfLiberty": "+40.6894-074.0447"
}
JSON結構和保留屬性名
為了使APIs保持一致的藉口，JSON物件應當使用以下的結構。該結構適用於JSON的請求和響應。在這個結構中，某些屬性名將被保留用作特殊用途。這些屬性並不是必需的，也就是說，每個保留的屬性可能出現零次或一次。但是如果服務需要這些屬性，建議遵循該命名條約。下面是一份JSON結構語義表，以Orderly格式呈現(現在已經被納入 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?; # date formatted 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物件，這兩者不會同時出現。下面是這些屬性的解釋。
頂級保留屬性名稱
頂級的JSON物件可能包含下面這些屬性
apiVersion
屬性值型別: 字串(string)
父節點: -
呈現請求中服務API期望的版本，以及在響應中儲存的服務API版本。應隨時提供apiVersion。這與資料的版本無關。將資料版本化應該通過其他的機制來處理，如etag。
示例：
{ "apiVersion": "2.1" }
context
屬性值型別: 字串(string)
父節點: -
客戶端設定這個值，伺服器通過資料作出迴應。這在JSON-P和批處理中很有用，使用者可以使用context將響應與請求關聯起來。該屬性是頂級屬性，因為不管響應是成功還是有錯誤，context總應當被呈現出來。context不同於id在於context由使用者提供而id由服務分配。
示例：
請求 #1:
http://www.google.com/myapi?context=bart
請求 #2:
http://www.google.com/myapi?context=lisa
響應 #1:
{
"context": "bart",
"data": {
"items": []
}
}
響應 #2:
{
"context": "lisa",
"data": {
"items": []
}
}
公共的JavaScript處理器通過編碼同時處理以下兩個響應：
function handleResponse(response) {
if (response.result.context == "bart") {
// 更新頁面中的 "Bart" 部分。
} else if (response.result.context == "lisa") {
// 更新頁面中的 "Lisa" 部分。
}
}
id
屬性值型別: 字串(string)
父節點: -
服務提供用於識別響應的標識(無論請求是成功還是有錯誤)。這對於將服務日誌和單獨收到的響應對應起來很有用。
示例：
{ "id": "1" }
method
屬性值型別: 字串(string)
父節點: -
表示對資料即將執行，或已被執行的操作。在JSON請求的情況下，method屬性可以用來指明對資料進行何種操作。在JSON響應的情況下，method屬性表明對資料進行了何種操作。
一個JSON-RPC請求的例子，其中method屬性表示要在params上執行的操作：
{
"method": "people.get",
"params": {
"userId": "@me",
"groupId": "@self"
}
}
params
屬性值型別: 物件(object)
父節點: -
這個物件作為輸入引數的對映傳送給RPC請求。它可以和method屬性一起用來執行RPC功能。若RPC方法不需要引數，則可以省略該屬性。
示例：
{
"method": "people.get",
"params": {
"userId": "@me",
"groupId": "@self"
}
}
data
屬性值型別: 物件(object)
父節點: -
包含響應的所有資料。該屬性本身擁有許多保留屬性名，下面會有相應的說明。服務可以自由地將自己的資料新增到這個物件。一個JSON響應要麼應當包含一個data物件，要麼應當包含error物件，但不能兩者都包含。如果data和error同時出現，則error物件優先。
error
屬性值型別: 物件(object)
父節點: -
表明錯誤發生，提供錯誤的詳細資訊。錯誤的格式支援從服務返回一個或多個錯誤。一個JSON響應可以有一個data物件或者一個error物件，但不能兩者都包含。如果data和error都出現，error物件優先。
示例：
{
"apiVersion": "2.0",
"error": {
"code": 404,
"message": "File Not Found",
"errors": [{
"domain": "Calendar",
"reason": "ResourceNotFoundException",
"message": "File Not Found
}]
}
}
data物件的保留屬性名
JSON物件的data屬性可能包含以下屬性。
data.kind
屬性值型別: 字串(sting)
父節點: data
kind屬性是對某個特定的物件儲存何種型別的資訊的指南。可以把它放在data層次，或items的層次，或其它任何有助於區分各類物件的物件中。如果kind物件被提供，它應該是物件的第一個屬性（詳見下面的屬性順序部分）。
示例：
// "Kind" indicates an "album" in the Picasa API.
{"data": {"kind": "album"}}
data.fields
屬性值型別: 字串(string)
父節點: data
表示做了部分GET之後響應中出現的欄位，或做了部分PATCH之後出現在請求中的欄位。該屬性僅在做了部分GET請求/批處理時存在，且不能為空。
示例：
{
"data": {
"kind": "user",
"fields": "author,id",
"id": "bart",
"author": "Bart"
}
}
data.etag
屬性值型別: 字串(string)
父節點: data
響應時提供etag。關於GData APIs中的ETags詳情可以在這裡找到：http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning
示例：
{"data": {"etag": "W/"C0QBRXcycSp7ImA9WxRVFUk.""}}
data.id
屬性值型別: 字串(string)
父節點: data
一個全域性唯一識別符號用於引用該物件。id屬性的具體細節都留給了服務。
示例：
{"data": {"id": "12345"}}
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!" }
]}
}
data.updated
屬性值型別: 字串(string)(格式由RFC 3339指定)
父節點: data
指明條目更新的最後日期/時間(RFC 3339)，由服務規定。
示例：
{"data": {"updated": "2007-11-06T16:34:41.000Z"}}
data.deleted
屬性值型別: 布林(boolean)
父節點: data (或任何子元素)
一個標記元素，當出現時，表示包含的條目已被刪除。如果提供了刪除屬性，它的值必須為true;為false會導致混亂，應該避免。
示例：
{"data": {
"items": [
{ "title": "A deleted entry",
"deleted": true
}
]}
}
data.items
屬性值型別: 陣列(array)
父節點: data
屬性名items被保留用作表示一組條目(例如,Picasa中的圖片，YouTube中的視訊)。這種結構的目的是給與當前結果相關的集合提供一個標準位置。例如，知道頁面上的items是陣列，JSON輸出便可能插入一個通用的分頁系統。如果items存在，它應該是data物件的最後一個屬性。（詳見下面的屬性順序部分）。
示例：
{
"data": {
"items": [
{ /* Object #1 */ },
{ /* Object #2 */ },
...
]
}
}
用於分頁的保留屬性名
下面的屬性位於data物件中，用來給一列資料分頁。一些語言和概念是從OpenSearch規範中借鑑過來的。
下面的分頁資料允許各種風格的分頁，包括：
上一頁/下一頁 - 允許使用者在列表中前進和後退，一次一頁。nextLink 和previousLink屬性 (下面的"連結保留屬性名"部分有描述) 用於這種風格的分頁。
基於索引的分頁 - 允許使用者直接跳到條目列表的某個條目位置。例如，要從第200個條目開始載入10個新的條目，開發者可以給使用者提供一個URL的查詢字串?startIndex=200。
基於頁面的分頁 - 允許使用者直接跳到條目內的具體頁。這跟基於索引的分頁很類似,但節省了開發者額外的步驟，不需再為新一頁的條目計算條目索引。例如，開發人員可以直接跳到第20頁，而不是跳到第200條條目。基於頁面分頁的網址，可以使用查詢字串?page=1或?page=20。pageIndex和 totalPages 屬性用作這種風格的分頁.
在這份指南的最後可以找到如何使用這些屬性來實現分頁的例子。
data.currentItemCount
屬性值型別: 整數(integer)
父節點: data
結果集中的條目數目。應該與items.length相等，並作為一個便利屬性提供。例如，假設開發者請求一組搜尋條目，並且要求每頁10條。查詢集共有14條。第一個條目頁將會有10個條目，因此itemsPerPage和currentItemCount都應該等於10。下一頁的條目還剩下4條；itemsPerPage仍然是10,但是currentItemCount是4.
示例：
{
"data": {
// "itemsPerPage" 不需要與 "currentItemCount" 匹配
"itemsPerPage": 10,
"currentItemCount": 4
}
}
data.itemsPerPage
屬性值型別: 整數(integer)
父節點: data
items結果的數目。未必是data.items陣列的大小；如果我們檢視的是最後一頁，data.items的大小可能小於itemsPerPage。但是，data.items的大小不應超過itemsPerPage。
示例：
{
"data": {
"itemsPerPage": 10
}
}
data.startIndex
屬性值型別: 整數(integer)
父節點: data
data.items中第一個條目的索引。為了一致，startIndex應從1開始。例如，第一組items中第一條的startIndex應該是1。如果使用者請求下一組資料，startIndex可能是10。
示例：
{
"data": {
"startIndex": 1
}
}
data.totalItems
屬性值型別: 整數(integer)
父節點: data
當前集合中可用的總條目數。例如，如果使用者有100篇部落格文章，響應可能只包含10篇，但是totalItems應該是100。
示例：
{
"data": {
"totalItems": 100
}
}
data.pagingLinkTemplate
屬性值型別: 字串(string)
父節點: data
URL模板指出使用者可以如何計算隨後的分頁連結。URL模板中也包含一些保留變數名：表示要載入的條目的{index}，和要載入的頁面的{pageIndex}。
示例：
{
"data": {
"pagingLinkTemplate": "http://www.google.com/search/hl=en&q=chicago+style+pizza&start={index}&sa=N"
}
}
data.pageIndex
屬性值型別: 整數(integer)
父節點: data
條目的當前頁索引。為了一致，pageIndex應從1開始。例如，第一頁的pageIndex是1。pageIndex也可以通過基於條目的分頁而計算出來pageIndex = floor(startIndex / itemsPerPage) + 1。
示例：
{
"data": {
"pageIndex": 1
}
}
data.totalPages
屬性值型別: 整數(integer)
父節點: data
當前結果集中的總頁數。totalPages也可以通過上面基於條目的分頁屬性計算出來: totalPages = ceiling(totalItems / itemsPerPage).。
示例：
{
"data": {
"totalPages": 50
}
}
用於連結的保留屬性名
下面的屬性位於data物件中，用來表示對其他資源的引用。有兩種形式的連結屬性：1）物件，它可以包含任何種類的引用（比如JSON-RPC物件），2)URL字串，表示資源的URIs(字尾總為'Link')。
data.self / data.selfLink
屬性值型別: 物件(object)/字串(string)
父節點: data
自身連結可以用於取回條目資料。比如，在使用者的Picasa相簿中，條目中的每個相簿物件都會包含一個selfLink用於檢索這個相簿的相關資料。
示例：
{
"data": {
"self": { },
"selfLink": "http://www.google.com/feeds/album/1234"
}
}
data.edit / data.editLink
屬性值型別: 物件(object)/字串(string)
父節點: data
編輯連結表明使用者可以傳送更新或刪除請求。這對於REST風格的APIs很有用。該連結僅在使用者能夠更新和刪除該條目時提供。
示例：
{
"data": {
"edit": { },
"editLink": "http://www.google.com/feeds/album/1234/edit"
}
}
data.next / data.nextLink
屬性值型別: 物件(object)/字串(string)
父節點: data
該下一頁連結標明如何取得更多資料。它指明載入下一組資料的位置。它可以同itemsPerPage，startIndex 和 totalItems 屬性一起使用用於分頁資料。
示例：
{
"data": {
"next": { },
"nextLink": "http://www.google.com/feeds/album/1234/next"
}
}
data.previous / data.previousLink
屬性值型別: 物件(object)/字串(string)
父節點: data
該上一頁連結標明如何取得更多資料。它指明載入上一組資料的位置。它可以連同itemsPerPage，startIndex 和 totalItems 屬性用於分頁資料。
示例：
{
"data": {
"previous": { },
"previousLink": "http://www.google.com/feeds/album/1234/next"
}
}
錯誤物件中的保留屬性名
JSON物件的error屬性應包含以下屬性。
error.code
屬性值型別: 整數(integer)
父節點: error
表示該錯誤的編號。這個屬性通常表示HTTP響應碼。如果存在多個錯誤，code應為第一個出錯的錯誤碼。
示例：
{
"error":{
"code": 404
}
}
error.message
屬性值型別: 字串(string)
父節點: error
一個人類可讀的資訊，提供有關錯誤的詳細資訊。如果存在多個錯誤，message應為第一個錯誤的錯誤資訊。
示例：
{
"error":{
"message": "File Not Found"
}
}
error.errors
屬性值型別: 陣列(array)
父節點: error
包含關於錯誤的附加資訊。如果服務返回多個錯誤。errors陣列中的每個元素表示一個不同的錯誤。
示例：
{ "error": { "errors": [] } }
error.errors[].domain
屬性值型別: 字串(string)
父節點: error.errors
服務丟擲該錯誤的唯一識別符。它幫助區分服務的從普通協議錯誤(如,找不到檔案)中區分出具體錯誤(例如，給日曆插入事件的錯誤)。
示例：
{
"error":{
"errors": [{"domain": "Calendar"}]
}
}
error.errors[].reason
屬性值型別: 字串(string)
父節點: error.errors
該錯誤的唯一識別符。不同於error.code屬性，它不是HTTP響應碼。
示例：
{
"error":{
"errors": [{"reason": "ResourceNotFoundException"}]
}
}
error.errors[].message
屬性值型別: 字串(string)
父節點: error.errors
一個人類可讀的資訊，提供有關錯誤的更多細節。如果只有一個錯誤，該欄位應該與error.message匹配。
示例：
{
"error":{
"code": 404
"message": "File Not Found",
"errors": [{"message": "File Not Found"}]
}
}
error.errors[].location
屬性值型別: 字串(string)
父節點: error.errors
錯誤發生的位置（根據locationType欄位解釋該值）。
示例：
{
"error":{
"errors": [{"location": ""}]
}
}
error.errors[].locationType
屬性值型別: 字串(string)
父節點: error.errors
標明如何解釋location屬性。
示例：
{
"error":{
"errors": [{"locationType": ""}]
}
}
error.errors[].extendedHelp
屬性值型別: 字串(string)
父節點: error.errors
help text的URI，使錯誤更易於理解。
示例：（注：原示例這裡有筆誤，中文版這裡做了校正）
{
"error":{
"errors": [{"extendedHelp": "http://url.to.more.details.example.com/"}]
}
}
error.errors[].sendReport
屬性值型別: 字串(string)
父節點: error.errors
report form的URI，服務用它來收集錯誤狀態的資料。該URL會預先載入描述請求的引數
示例：
{
"error":{
"errors": [{"sendReport": "http://report.example.com/"}]
}
}
屬性順序
在JSON物件中屬性可有任意順序。然而，在某些情況下，有序的屬性可以幫助分析器快速解釋資料，並帶來更好的效能。在移動環境下的解析器就是個例子，在這種情況下，效能和記憶體是至關重要的，不必要的解析也應儘量避免。
Kind屬性
Kind屬性應為第一屬性
假設一個解析器負責將一個原始JSON流解析成一個特定的物件。kind屬性會引導解析器將適合的物件例項化。因而它應該是JSON物件的第一個屬性。這僅適用於物件有一個kind屬性的情況(通常可以在data和items屬性中找到)。
Items屬性
items應該是data物件的最後一個屬性
這使得閱讀每一個具體條目前前已讀所有的集合屬性。在有很多條目的情況下，這樣就避免了開發人員只需要從資料的欄位時不必要的解析這些條目。
這讓閱讀所有集合屬性先於閱讀單個條目。如遇多個條目的情況，當開發者僅需要資料中的欄位時，這就可避免解析不必要的條目。
屬性順序示例：
// "kind" 屬性區分 "album" 和 "photo".
// "Kind" 始終是它父物件的第一個屬性.
// "items" 屬性是 "data" 物件的最後一個屬性.
{
"data": {
"kind": "album",
"title": "My Photo Album",
"description": "An album in the user's account",
"items": [
{
"kind": "photo",
"title": "My First Photo"
}
]
}
}
示例
YouTube JSON API
這是YouTube JSON API響應物件的示例。你可以從中學到更多關於YouTube JSON API的內容：http://code.google.com/apis/youtube/2.0/developers_guide_jsonc.html
{
"apiVersion": "2.0",
"data": {
"updated": "2010-02-04T19:29:54.001Z",
"totalItems": 6741,
"startIndex": 1,
"itemsPerPage": 1,
"items": [
{
"id": "BGODurRfVv4",
"uploaded": "2009-11-17T20:10:06.000Z",
"updated": "2010-02-04T06:25:57.000Z",
"uploader": "docchat",
"category": "Animals",
"title": "From service dog to SURFice dog",
"description": "Surf dog Ricochets inspirational video ...",
"tags": [
"Surf dog",
"dog surfing",
"dog",
"golden retriever",
],
"thumbnail": {
"default": "http://i.ytimg.com/vi/BGODurRfVv4/default.jpg",
"hqDefault": "http://i.ytimg.com/vi/BGODurRfVv4/hqdefault.jpg"
},
"player": {
"default": "http://www.youtube.com/watch?v=BGODurRfVv4&feature=youtube_gdata",
"mobile": "http://m.youtube.com/details?v=BGODurRfVv4"
},
"content": {
"1": "rtsp://v5.cache6.c.youtube.com/CiILENy73wIaGQn-Vl-0uoNjBBMYDSANFEgGUgZ2aWRlb3MM/0/0/0/video.3gp",
"5": "http://www.youtube.com/v/BGODurRfVv4?f=videos&app=youtube_gdata",
"6": "rtsp://v7.cache7.c.youtube.com/CiILENy73wIaGQn-Vl-0uoNjBBMYESARFEgGUgZ2aWRlb3MM/0/0/0/video.3gp"
},
"duration": 315,
"rating": 4.96,
"ratingCount": 2043,
"viewCount": 1781691,
"favoriteCount": 3363,
"commentCount": 1007,
"commentsAllowed": true
}
]
}
}
分頁示例
如何將Google搜尋條目作為JSON物件展現出來，對分頁變數也有特別關注。
這個示例僅用作說明。下面的API實際上並不存在。
這是Google搜尋結果頁面的示例：
這是該頁面JSON形式的呈現：
{
"apiVersion": "2.1",
"id": "1",
"data": {
"query": "chicago style pizza",
"time": "0.1",
"currentItemCount": 10,
"itemsPerPage": 10,
"startIndex": 11,
"totalItems": 2700000,
"nextLink": "http://www.google.com/search?hl=en&q=chicago+style+pizza&start=20&sa=N"
"previousLink": "http://www.google.com/search?hl=en&q=chicago+style+pizza&start=0&sa=N",
"pagingLinkTemplate": "http://www.google.com/search/hl=en&q=chicago+style+pizza&start={index}&sa=N",
"items": [
{
"title": "Pizz'a Chicago Home Page"
// More fields for the search results
}
// More search results
]
}
}
這是如何展現螢幕截圖中的色塊的例子（背景顏色對應下圖中的顏色）
Results 11 - 20 of about 2,700,000 = startIndex
Results 11 - 20 of about 2,700,000 = startIndex + currentItemCount - 1
Results 11 - 20 of about 2,700,000 = totalItems
Search results = items (formatted appropriately)
Previous/Next = previousLink / nextLink
Numbered links in "Gooooooooooogle" = Derived from "pageLinkTemplate". The developer is responsible for calculating the values for {index} and substituting those values into the "pageLinkTemplate". The pageLinkTemplate's {index} variable is calculated as follows:
Index #1 = 0 * itemsPerPage = 0
Index #2 = 2 * itemsPerPage = 10
Index #3 = 3 * itemsPerPage = 20
Index #N = N * itemsPerPage
附錄
附錄A:JavaScript中的保留字
下列JavaScript保留字應該避免在屬性名中使用
下面的但在在JavaScript語言中被保留，不能作為在點訪問符中使用。這份名單代表此時的最佳關鍵字的知識;列表可能會改變或根據您的特定的執行環境更改。
下面是JavaScript語言中的保留字，且不能在點訪問符中使用。這份清單集合了當前最新的關鍵字，該清單可能會根據具體的執行環境而有所變更或改變。
abstract
boolean break byte
case catch char class const continue
debugger default delete do double
else enum export extends
false final finally float for function
goto
if implements import in instanceof int interface
let long
native new null
package private protected public
return
short static super switch synchronized
this throw throws transient true try typeof
var volatile void
while with
yield
除了特別說明，該頁面的內容均由共同創作協議(CC BY 3.0)授權許可，示例程式碼均由Apache 2.0許可證授權許可）
相關文章
- JS 風格指南JS
- JavaScript風格指南JavaScript
- Google JavaScript 風格指南GoJavaScript
- JavaScript編碼風格指南JavaScript
- RayWenderlich 官方 Swift 風格指南Swift
- JavaScript 編碼風格指南JavaScript
- Vue風格指南小結Vue
- JavaScript 程式碼風格指南JavaScript
- Vue 前端程式碼風格指南Vue前端
- Google JavaScript 程式碼風格指南GoJavaScript
- 中文寫作排版風格指南
- JavaScript 程式設計風格指南JavaScript程式設計
- CoffeeScript 編碼風格指南
- Python 編碼風格指南Python
- 公開“Google開發者文件風格指南”Go
- PHP 編碼風格規範指南PHP
- Google Java 程式設計風格指南GoJava程式設計
- 前端程式碼規範 — JavaScript 風格指南前端JavaScript
- 《英雄聯盟》VFX視覺風格指南視覺
- Google Python 程式設計風格指南GoPython程式設計
- Google C++程式設計風格指南GoC++程式設計
- PEP 8 Python編碼風格指南概要Python
- Google C++ 程式設計風格指南：類GoC++程式設計
- Google C++ 程式設計風格指南：格式GoC++程式設計
- PEP 8 程式程式碼的編寫風格指南
- 《Google 開源專案風格指南》中文版Go
- Go 語言程式碼風格規範-指南篇Go
- Google C++ 程式設計風格指南：作用域GoC++程式設計
- Google C++ 程式設計風格指南：註釋GoC++程式設計
- JavaScript 風格指南/編碼規範（Airbnb公司版）JavaScriptAI
- Google C++程式設計風格指南（七）：格式GoC++程式設計
- 優步公司的Go語言編寫風格指南Go
- Google C++ 程式設計風格指南：命名約定GoC++程式設計
- 機器學習之光：神經風格遷移的直觀指南！機器學習
- .NET框架-微軟C#程式設計風格官方指南框架微軟C#程式設計
- 你聽說過“風格指南驅動開發”嗎？
- Google Java 程式設計風格指南 —— 見微知著GoJava程式設計
- Google C++程式設計風格指南（二）：作用域GoC++程式設計