树形结构的REST API样式

Question

I have items in tree structure. Each Item has Id and ParentId .

To get Item by Id I use items/:id

What is the best way to create endpoint for GetItemsByParentId(parentId) method?

Answer 1

You would rather ask a person "Who are your children" than "Who has you as parent", wouldn't you? That said I suggest to use /items/{id}/children .

The response you get from the server usually contains the appropriate link in that case:

{
  links: {
    self: "http://foo/items/2",
    children: "http://foo/items/2/children"
  },
  ...
}

Your API could also support embedding children on demand. Something like http://foo/items/2?embedChildren or a different media type in the Accept header could then return:

{
  links: {
    self: "http://foo/items/2",
    children: "http://foo/items/2/children"
  }
  children: [
   ...
  ],
  ... 
} 

Including the children link in that case too is a good idea. That way you can still add children posting to that URL.