合成还是副业？

Question

我对构建API还比较陌生，现在我遇到了以下两个术语，并且有点困惑。我希望有人能告诉我一些我甚至在维基百科上都找不到的定义。我不确定它们是否可以可靠地互换使用，而不会让人感到不安，或者这取决于你与谁交谈。

旁瓣

• 可选地将其他相关资源包括在响应中的能力 例如：/accounts?include=transactions将在我的/accounts资源响应中包含transactions资源？
• 这实际上意味着我们在响应中避免资源重复，方法是将资源移出到消息的自己部分，即 { "orders": [ { "id": "101", "product": { "id": "2000", "desc": "blah", "price": "100.0" } "id": "102", "product": { "id": "2000", "desc": "blah", "price": "100.0" } 我们应该： { "orders": [ { "id": "101", "product": { "id": "2000" } "id": "102", "product": { "id": "2000" } ], "products": [ { "id": "2000", "desc": "blah", "price": "100.0" }

复合文档

• 简单地说，这意味着你在资源响应中混合了相关资源(也可以是独立的)。accounts和transactions资源可以单独请求，也可以合并在同一个复合文档中？

Answer 1

我从来没有遇到过什么，我会认为一个正式的定义，无论是旁位还是复合，我认为你可以定义你想要的，只要它符合你的资源是如何建模的。

我无法想象人们会对这个术语感到太不高兴。基本前提是健全，其他一切都只是语义和实现:)。也就是说，保持API对象模型相对于客户端的纯正和功能是一个好主意。

因此，如果它最有可能以嵌套产品的方式使用，并且这是API自然的样子，那么

{ "orders": [ { 
  "id": "101", 
    "product": { "id": "2000", "desc": "blah", "price": "100.0" }
  "id": "102", 
    "product": { "id": "2000", "desc": "blah", "price": "100.0" }

可能不是一个问题，而不是增加的间接

 {  "orders": [ { 
     "id": "101", 
        "product": { "id": "2000" }
     "id": "102", 
        "product": { "id": "2000" } 
     ],
    "products": [
         { "id": "2000", "desc": "blah", "price": "100.0" }