JSON結(jié)構(gòu)和保留屬性名

2018-02-24 15:12 更新

為了使APIs保持一致的借口,JSON對(duì)象應(yīng)當(dāng)使用以下的結(jié)構(gòu)。該結(jié)構(gòu)適用于JSON的請(qǐng)求和響應(yīng)。在這個(gè)結(jié)構(gòu)中,某些屬性名將被保留用作特殊用途。這些屬性并不是必需的,也就是說,每個(gè)保留的屬性可能出現(xiàn)零次或一次。但是如果服務(wù)需要這些屬性,建議遵循該命名條約。下面是一份JSON結(jié)構(gòu)語(yǔ)義表,以O(shè)rderly格式呈現(xiàn)(現(xiàn)在已經(jīng)被納入 JSONSchema)。你可以在該指南的最后找到關(guān)于JSON結(jié)構(gòu)的例子。

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對(duì)象有一些頂級(jí)屬性,然后是_data_對(duì)象或_error_對(duì)象,這兩者不會(huì)同時(shí)出現(xiàn)。下面是這些屬性的解釋。

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)