以RESTful方式返回具有多种类型的对象

Question

我目前正在设计一种API，以处理来自移动客户端的请求。 为了实现后端和客户端之间的某种程度的解耦，我想以RESTful的方式定义Web服务。 我面临的挑战是为单个调用返回具有不同类型的多个对象。

可以说我们有以下模型：

• 海港 ...顶级条目
• 船棚 ...分配给特定港口（0..n）
• Boat ...分配给特定的船棚（0..n），或直接分配给港口（0..n）

据我了解REST，如果现在我想显示港口中的所有船只和棚屋，我将发送两个请求：

/harbours/{harbour_id}/boats返回所有船只的列表。 棚屋中的船将包含一个链接到其所在棚屋的ID

/harbours/{harbour_id}/sheds返回所有棚屋的列表

因为我想在移动场景中使用Web服务，所以将这两个调用合并为一个是理想的。 然后，这可以返回其中嵌套有棚棚对象的船只列表，也可以并排返回两种对象类型：

/harbours/22/boats

[
   {
      "id":1,
      "boatName":"Mary",
      "boatShed":{
         "id":1,
         "shedName":"Dock 1",
         "capacity":55
      }
   },
   {
      "id":2,
      "boatName":"Jane",
      "boatShed":{
         "id":1,
         "shedName":"Dock 1",
         "capacity":55
      }
   }
]

要么

/harbours/22/boats

{
   "boats":[
      {
         "id":1,
         "boatName":"Mary",
         "boatShedId":1
      },
      {
         "id":2,
         "boatName":"Jane",
         "boatShedId":1
      }
   ],
   "sheds":[
      {
         "id":1,
         "shedName":"Dock 1",
         "capacity":55
      }
   ]
}

我现在的问题是，以下哪种方式更接近REST背后的想法，或者它根本不是RESTful的？

Answer 1

正如@Tarken提到的/boats请求不应在顶层返回棚子（因为url假定您正在请求收集资源Boat ）

如果您的关系定义如下

Harbour:
    boats: Boat[]
    sheds: Shed[]

Shed:
    boats: Boat[]

Boat:
    harbour: Harbour
    shed: Shed

/harbours/ID然后返回包含boats和sheds关系集的Harbour表示。

{
  boats: 
  [
    { Boat },
    { Boat },
    ..
  ],
  sheds: 
  [
    { Shed },
    { Shed },
    ..
  ],
  ...
}

这里没有什么违反宁静的原则的-URL唯一地标识资源，并且资源表示可以是任何东西，也具有指向其他资源的链接。

Answer 2

创建一个包含“ Boat Shed和“ Boat信息的Harbour模型。 如果我正在用Java实现服务，那么我会做这样的事情：

class Boat{
...
}

class BoatShed{
...
}

class Harbour{
List<Boat> boats;
List<BoatShed> boatSheds;
...
}

您可以创建类似/api/harbours/{harbourId}的API。

根据您的问题，您想显示harbour中的所有船只和棚架，例如id=1234 ，您可以发出如下请求：

GET /api/harbours/1234

这将返回Boats列表和Boat Sheds列表，如下所示：

{
"boats":[
  {
     "id":1,
     "boatName":"Mary",
     "boatShedId":1
  },
  {
     "id":2,
     "boatName":"Mary2",
     "boatShedId":2
  }
],
"sheds":[
  {
     "id":1,
     "shedName":"Dock 1",
     "capacity":55
  },
  {
     "id":2,
     "shedName":"Dock 2",
     "capacity":50
  }
  ]
}

编辑当你想要得到boats和Sheds通过发送一个请求，并排api/hourbours/{id}按照看起来不错REST API的设计原则。

要求boats所有sheds都不符合理想的REST API设计，但是如果要实现相同的目的，可以执行以下操作。

如果您想这样做，那么first one /api//harbours/{id}/boats对我来说很好。