php - RESTful多个资源关联时，应如何返回数据？

Question

比如想获取XX公司XX部门XX用户的地址，设计的URL可能会是这样：

GET: /companies/${id}/departments/${id}/users/${id}/address

json方式的返回结果应该如何组织呢？

一些人不清楚问的是什么意思，我再多描述些。

比如返回结果可以是：

{
    "code": 200,
    "message": "xxx",
    "results": [
        {
            "xxx": "xxx"    // address的信息列表
        }
    ]
}

因为是多个资源进行关联，有些对于results也可能会这样返回：

{
     "company": {
          "xxx": "xxx",    // company的信息列表
          "department": {
              "xxx": "xxx"    // department的信息列表
              "address": {    // 最后是address的信息列表
                  "xxx": "xxx"
              }
          }
     }
}

还有使用Hypermedia API的设计方式（HATEOAS），也就是说对于company，他不返回${id}对应的信息，而是返回一个链接。（对于HATEOAS，我也是比较迷糊的状态）

所以...对于多个资源关联查询，结果应该以何种json结构返回呢？

Answer 1

ls为毛会－1，说的有啥问题没
你的最终目的是get地址，响应把获取的地址返回给客户端不就可以了吗，怎么会需要在意请求的url?

Answer 2

不是很清楚在问什么
返回的json格式吗?
前端需要什么数据就返回什么数据呗
如果只需要用到地址
就直接返回{"address": address}
如果前端跟后端有约定返回格式,就按格式返回就好了
例如

json{
    "status": STATUS, //可能为请求状态码,表示请求成功与否
    "data": {
        "address": address,//主要获取的信息
        "other": other//其他可能需要的信息
    }
}

Answer 3

根据你的 URI，各对象的关系如下图（把地址做了展开）：

从「资源」的角度来看，URI 已经很清晰，取「某人的地址」，那么直接返回即可（假设 MediaType 是 JSON）：

{
    "province" : "上海市",
    "city" : "上海市",
    "district" : "黄浦区",
    "address" : "日月光广场"
}

目前我的设计原则如下（可能还不够规范，持续改进中）：

• 使用 HTTP Status Code 返回成功失败；
• 如果 Status Code 不是 200/201 再返回 Error Object，此时再增加自定义错误信息，有对应的 Code 和 Message；
• 可以考虑在 Address 增加 Link，一个是是 Address URI，另一个是 User URI；

关于 HATEOAS 还在理解中，不敢乱说 :P

开发中的产品基于 REST 架构，也在读下面的几本书，方便的话多交流：

• RESTful Web Services Cookbook 中文版 ，针对使用 REST 过程中的一些疑惑，作者几乎都有了思考和答案；
• REST 实战 ，加强理论知识用的，因为李锟的推荐；
• RESTful Web APIs 中文版 刚刚同入手，正要拜读；

Answer 4

'address'