前端代碼編寫(xiě)規(guī)范-資料下載頁(yè)
2025-04-08 13:43本頁(yè)面
【正文】 s必須(MUST)為200。通常JSON數(shù)據(jù)被用于通過(guò)XMLHttpRequest對(duì)象訪(fǎng)問(wèn)，通過(guò)javascript進(jìn)行處理。返回錯(cuò)誤的狀態(tài)碼可能導(dǎo)致錯(cuò)誤不被響應(yīng)，數(shù)據(jù)不被處理。ContentTypeContentType字段定義了響應(yīng)體的類(lèi)型。一般情況下，瀏覽器會(huì)根據(jù)該類(lèi)型對(duì)內(nèi)容進(jìn)行正確的處理。對(duì)于傳輸JSON數(shù)據(jù)的響應(yīng)，ContentType推薦(RECOMMENDED)設(shè)置為text/javascript或text/plain。避免(MUST NOT)將ContextType設(shè)置為text/html，否則可能導(dǎo)致安全問(wèn)題。ContentType中可以指定字符集。通常需要(SHOULD)明確指定一個(gè)字符集。如果是通過(guò)XMLHTTPRequest請(qǐng)求的數(shù)據(jù)，并且字符編碼為UTF8時(shí)，可以不指定字符集。ContextType示例text/javascript。charset=UTF8數(shù)據(jù)字段返回的數(shù)據(jù)包含在響應(yīng)體中。數(shù)據(jù)必須(MUST)是一個(gè)JSON Object。該Object可能包含3個(gè)字段：status，statusInfo，data。statusstatus字段必須(MUST)是一個(gè)不小于0的JSON Number整數(shù)，表示請(qǐng)求的狀態(tài)。這個(gè)字段可以(SHOULD)被省略，省略時(shí)和為0時(shí)表示同一含義。0：表示server端理解了請(qǐng)求，成功處理并返回。非0：表示發(fā)生錯(cuò)誤?？梢?SHOULD)根據(jù)錯(cuò)誤類(lèi)型擴(kuò)展錯(cuò)誤碼。一個(gè)成功請(qǐng)求的status字段{ status: 0, data: hello world!}statusInfostatusInfo字段通常(SHOULD)是一個(gè)JSON String或JSON Object，表示除了請(qǐng)求狀態(tài)外server端想要對(duì)status做出的說(shuō)明，使client端能夠獲取更多信息進(jìn)行后續(xù)處理。這個(gè)字段是可選的(OPTIONAL)下面的兩個(gè)例子中，statusInfo字段的信息都可以用于client端程序的后續(xù)處理，但是粒度和處理方式會(huì)有不同。client端參數(shù)錯(cuò)誤的statusInfo簡(jiǎn)單說(shuō)明的statusInfo：{ status: 1, statusInfo: 參數(shù)錯(cuò)誤}具有更多信息的statusInfo：{ status: 1, statusInfo: { text: 參數(shù)錯(cuò)誤, parameters: { 電子郵件格式不正確 } }}datadata字段可以是除JSON Null之外的任意JSON類(lèi)型，表示請(qǐng)求返回的數(shù)據(jù)主體。這個(gè)字段是可選的(OPTIONAL)數(shù)據(jù)主體data包含了在請(qǐng)求成功時(shí)有意義的數(shù)據(jù)。一個(gè)查詢(xún)姓名請(qǐng)求的返回?cái)?shù)據(jù){ status: 0, data: Lily}鍵/值對(duì)象對(duì)于在一個(gè)JSON Object中表示鍵/值： 鍵的屬性名必須(MUST)為name，杜絕(MUST NOT)使用key或k 值的屬性名必須(MUST)為value，杜絕(MUST NOT)使用v。數(shù)據(jù)場(chǎng)景：鍵/值對(duì)象{ name: BMW, value: 1}鍵/值有序集合鍵/值有序集合表示對(duì)事務(wù)或邏輯類(lèi)型的抽象與分類(lèi)。常見(jiàn)的應(yīng)用場(chǎng)景有單選復(fù)選框集合，下拉菜單等。標(biāo)準(zhǔn)的鍵/值有序集合是一個(gè)JSON Array，集合中的每一項(xiàng)是一個(gè)JSON Object。項(xiàng)必須(MUST)包含name和value屬性?？梢?MAY)通過(guò)其他的屬性修飾每一項(xiàng)的特殊信息，如selected。數(shù)據(jù)場(chǎng)景：鍵/值有序集合[ { name: BMW, value: 1 }, { name: Benz, value: 2, selected: true }]樹(shù)樹(shù)形數(shù)據(jù)用于表示層疊的數(shù)據(jù)結(jié)構(gòu)。樹(shù)型數(shù)據(jù)必須(MUST)是一個(gè)JSON Object，代表樹(shù)型數(shù)據(jù)的根節(jié)點(diǎn)。下面是標(biāo)準(zhǔn)定義的可選節(jié)點(diǎn)列表，不在列表中的屬性可以(SHOULD)自行擴(kuò)展。樹(shù)型數(shù)據(jù)結(jié)構(gòu)的可選節(jié)點(diǎn)屬性 {Number|String} id 節(jié)點(diǎn)的唯一標(biāo)識(shí)。 {String} text 名稱(chēng)或用于顯示的字符串。 {Array} children 子節(jié)點(diǎn)列表。數(shù)據(jù)場(chǎng)景：樹(shù)型數(shù)據(jù){ id: 1, text: 中國(guó), children: [ { id: 10, text: 北京, children: [ { id: 100, text: 東城區(qū) }, { id: 101, text: 西城區(qū) }, { id: 102, text: 海淀區(qū) } ...... ] }, { id: 31, text: 海南, children: [ { id: 600, text: ?？? }, { id: 601, text: 三亞 }, { id: 602, text: 五指山 } ...... ] } ...... ]}
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1