REST API modeling

Question

我有两个模型，一个笔记本和一个笔记。

我有两条路线可以达到相同的目的（为特定笔记本发布注释）

POST /api/note，需要在提交的数据中传递笔记本引用（id）

POST /api/notebook/[ID]/note ，现在只有笔记数据

请注意，我不需要"不会附加到笔记本的笔记"。

我阅读了许多关于 REST API 的文档，但我可以找出什么是"最佳"方法。

这里有人为我准备一些好的文档吗？

Answer 1

我假设一个笔记只能存在于一个笔记本中。然后，笔记是笔记本的子资源。注释由

/api/notebook/{notebookId}/note/{noteId}

笔记本内的新笔记由

POST /api/notebook/1234/note
Content-Type: application/json
{
  // details of the note without reference to the notebook
}

服务器返回

201 Created
Location: /api/notebook/1234/note/B175A7F2-1434-11E5-AFD4-82854B860EDE

B175A7F2-1434-11E5-AFD4-82854B860EDE是服务器分配给新笔记的唯一 ID。