W3Cschool
恭喜您成為首批注冊用戶
獲得88經(jīng)驗值獎勵
頂級的JSON對象可能包含下面這些屬性
屬性值類型: 字符串(string)
父節(jié)點: -
呈現(xiàn)請求中服務(wù)API期望的版本,以及在響應(yīng)中保存的服務(wù)API版本。應(yīng)隨時提供apiVersion。這與數(shù)據(jù)的版本無關(guān)。將數(shù)據(jù)版本化應(yīng)該通過其他的機制來處理,如etag。
示例:
{ "apiVersion": "2.1" }
屬性值類型: 字符串(string)
父節(jié)點: -
客戶端設(shè)置這個值,服務(wù)器通過數(shù)據(jù)作出回應(yīng)。這在JSON-P和批處理中很有用,用戶可以使用_context_將響應(yīng)與請求關(guān)聯(lián)起來。該屬性是頂級屬性,因為不管響應(yīng)是成功還是有錯誤,_context_總應(yīng)當被呈現(xiàn)出來。_context_不同于_id_在于_context_由用戶提供而_id_由服務(wù)分配。
示例:
請求 #1:
http://www.google.com/myapi?context=bart
請求 #2:
http://www.google.com/myapi?context=lisa
響應(yīng) #1:
{
"context": "bart",
"data": {
"items": []
}
}
響應(yīng) #2:
{
"context": "lisa",
"data": {
"items": []
}
}
公共的JavaScript處理器通過編碼同時處理以下兩個響應(yīng):
function handleResponse(response) {
if (response.result.context == "bart") {
// 更新頁面中的 "Bart" 部分。
} else if (response.result.context == "lisa") {
// 更新頁面中的 "Lisa" 部分。
}
}
屬性值類型: 字符串(string)
父節(jié)點: -
服務(wù)提供用于識別響應(yīng)的標識(無論請求是成功還是有錯誤)。這對于將服務(wù)日志和單獨收到的響應(yīng)對應(yīng)起來很有用。
示例:
{ "id": "1" }
屬性值類型: 字符串(string)
父節(jié)點: -
表示對數(shù)據(jù)即將執(zhí)行,或已被執(zhí)行的操作。在JSON請求的情況下,_method_屬性可以用來指明對數(shù)據(jù)進行何種操作。在JSON響應(yīng)的情況下,_method_屬性表明對數(shù)據(jù)進行了何種操作。
一個JSON-RPC請求的例子,其中_method_屬性表示要在_params_上執(zhí)行的操作:
{
"method": "people.get",
"params": {
"userId": "@me",
"groupId": "@self"
}
}
屬性值類型: 對象(object)
父節(jié)點: -
這個對象作為輸入?yún)?shù)的映射發(fā)送給RPC請求。它可以和_method_屬性一起用來執(zhí)行RPC功能。若RPC方法不需要參數(shù),則可以省略該屬性。
示例:
{
"method": "people.get",
"params": {
"userId": "@me",
"groupId": "@self"
}
}
屬性值類型: 對象(object)
父節(jié)點: -
包含響應(yīng)的所有數(shù)據(jù)。該屬性本身擁有許多保留屬性名,下面會有相應(yīng)的說明。服務(wù)可以自由地將自己的數(shù)據(jù)添加到這個對象。一個JSON響應(yīng)要么應(yīng)當包含一個_data_對象,要么應(yīng)當包含_error_對象,但不能兩者都包含。如果_data_和_error_同時出現(xiàn),則_error_對象優(yōu)先。
屬性值類型: 對象(object)
父節(jié)點: -
表明錯誤發(fā)生,提供錯誤的詳細信息。錯誤的格式支持從服務(wù)返回一個或多個錯誤。一個JSON響應(yīng)可以有一個_data_對象或者一個_error_對象,但不能兩者都包含。如果_data_和_error_都出現(xiàn),_error_對象優(yōu)先。
示例:
{
"apiVersion": "2.0",
"error": {
"code": 404,
"message": "File Not Found",
"errors": [{
"domain": "Calendar",
"reason": "ResourceNotFoundException",
"message": "File Not Found
}]
}
}
Copyright©2021 w3cschool編程獅|閩ICP備15016281號-3|閩公網(wǎng)安備35020302033924號
違法和不良信息舉報電話:173-0602-2364|舉報郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號
聯(lián)系方式:
更多建議: