HAL JSON - 标准允许多层嵌入吗?

时间:2014-07-03 14:02:11

标签: json web-services rest hal-json

我想知道是否允许在JSON中的_embed元素中包含更多_embed元素,或者是否只有一个级别?

参见正常HAL的例子:

{
"_links": {
    "self": { "href": "/orders" },
    "curies": [{ "name": "ea", "href": "http://example.com/docs/rels/{rel}", "templated": true }],
    "next": { "href": "/orders?page=2" },
    "ea:find": {
        "href": "/orders{?id}",
        "templated": true
    },
    "ea:admin": [{
        "href": "/admins/2",
        "title": "Fred"
    }, {
        "href": "/admins/5",
        "title": "Kate"
    }]
},
"currentlyProcessing": 14,
"shippedToday": 20,
"_embedded": {
    "ea:order": [{
        "_links": {
            "self": { "href": "/orders/123" },
            "ea:basket": { "href": "/baskets/98712" },
            "ea:customer": { "href": "/customers/7809" }
        },
        "total": 30.00,
        "currency": "USD",
        "status": "shipped"
    }, {
        "_links": {
            "self": { "href": "/orders/124" },
            "ea:basket": { "href": "/baskets/97213" },
            "ea:customer": { "href": "/customers/12369" }
        },
        "total": 20.00,
        "currency": "USD",
        "status": "processing"
    }]
}

}

以及问题是什么(注意第二个嵌入是第一个嵌入的孩子):

{
   "_links" : {
     "self" : {
     "href" : "http://localhost:8090/fs/rest/roles/roleDefinition=Z1407031312513158080GIVMZ"
     }
   },
   "_embedded" : {
      "roles" : [ {
      "_links" : {
          "self" : {
               "href" : "http://localhost:8090/fs/rest/roles/Z1407031312513168080XCAKL"
           }
       },
       "id" : "Z1407031312513168080XCAKL",
        "_embedded" : {
             "roleDefinition" : {
              "_links" : {
              "self" : {
               "href" : "http://localhost:8090/fs/rest/roledefinitions/Z1407031312513158080GIVMZ"
        (rest ommitted)

Illustration of multiple levels of embedded resources

我自己正在阅读http://stateless.co/hal_specification.html的文档,因为嵌入式资源与普通资源相同,因此它可以再次包含嵌入式资源?

1 个答案:

答案 0 :(得分:0)

我也遇到过这个问题。好像答案是肯定还是否定。

因为嵌入的资源可以是

  

完整,部分或不一致的版本

,如果您使用_embedded标记或直接嵌入资源,则由实现者决定。

在我看来,最好像使用链接时一样返回嵌入式资源。 api的消费者可能已经编写了解析器来处理嵌入式资源(通常还包括_embedded标记)

https://tools.ietf.org/html/draft-kelly-json-hal-06#section-4.1.2

  

4.1.2。 _embedded

     

保留的“_embedded”属性是可选的

     

它是一个对象,其属性名称是链接关系类型(作为
  由[RFC5988]定义,值是资源对象或
  资源对象数组。

     

嵌入式资源可能是完整,部分或不一致的版本   从目标URI提供的表示。