如何用继承建模RESTful API？

Question

我的第一个想法是做这样的事情：

GET /animals        # get all animals
POST /animals       # create a dog or cat
GET /animals/123    # get animal 123

问题是/Animals集合现在是“不一致的”，因为它可以返回和接收结构不完全相同的对象（狗和猫）。集合返回具有不同属性的对象是否被认为是“RESTful”？

另一个解决方案是为每个具体类型创建URL，如下所示：

GET /dogs       # get all dogs
POST /dogs      # create a dog
GET /dogs/123   # get dog 123

GET /cats       # get all cats
POST /cats      # create a cat
GET /cats/123   # get cat 123

GET /animals    # get common attributes of all animals

Answer 1

我建议：

• 每个资源只使用一个URI
• 仅在属性级别区分动物

为同一资源设置多个URI从来都不是一个好主意，因为这会导致混乱和意外的副作用。鉴于此，您的单个URI应该基于类似/animals这样的通用方案。

{
   "animals":[
      {
         "link":"/animals/3424",
         "type":"dog",
         "name":"Rex"
      },
      {
         "link":"/animals/7829",
         "type":"cat",
         "name":"Mittens"
      }
   ]
}

null

然后，在创建或修改动物时，调用方有责任指定所涉及的动物类型：

媒体类型:application/vnd.vet-services.动物+json

{
   "type":"dog",
   "name":"Fido"
}

上面的有效负载可以通过post或put请求发送。